Skip to main content

Batch: Batches incoming workflow triggers/events for a duration to send consolidated notifications.

​
name
string
required

Human-readable name of the node

Example:

"Batch notifications"

​
node_type
string
required
Allowed value: "batch"
​
mode
enum<string>
required

accumulate_all: All events are accumulated in the batch and notification is sent once after batch window closes.

flush_leading_item: Notification is sent immediately for the first event in the batch and rest of the events are batched and sent after batch window closes. Eg. Send anomaly alert with first notification sent at the occurrence of first error and next alert sent after 30 minutes if there are further errors.

Available options:
accumulate_all,
flush_leading_item
​
window_type
enum<string>
required

Type of batching window.

fixed: Static window duration added as XXdXXhXXmXXs. Eg. 30s, 1h, 1d.

dynamic: Batch window duration is passed as variable in your trigger payload. Add the variable in jq format. Eg. .window_duration, $recipient.batch_duration, $actor.window_duration, $tenant.window_duration.

relative_to: Batch window is relative to a future timestamp passed in your trigger payload. Eg. 15 m before .task_end_time.

Available options:
fixed,
dynamic,
relative_to
​
description
string | null

Description of what this node does

​
fixed_window
string

Batch window when window_type is 'fixed'. Static batch window for all users. Format: XXdXXhXXmXXs.

Example:

"30s"

​
dynamic_window_expr
string

Batch window when window_type is 'dynamic'. jq-expression for deriving batch window duration at runtime.

Example:
{
  "trigger_payload": {
    "summary": "From trigger payload",
    "value": ".window_duration"
  },
  "recipient_property": {
    "summary": "From recipient properties",
    "value": "$recipient.batch_duration"
  },
  "actor_property": {
    "summary": "From actor properties",
    "value": "$actor.window_duration"
  },
  "tenant_property": {
    "summary": "From tenant properties",
    "value": "$tenant.window_duration"
  }
}
​
relative_to
object

Batch window when window_type is 'relative_to'. Batch window is calculated relative to a future timestamp.

​
retain_count
integer

Maximum number of items to retain after batch closes (1-100). The output variable set will have the latest or first n items based on the retain_order.

Required range: 1 <= x <= 100
​
retain_order
enum<string>

Retain items in this order when retain_count is specified.

Available options:
first,
last
​
batch_key
string

jq-expression used to group events into separate batches. For example, when sending batched notifications for comments on different documents, use .document_id as the batch key to ensure comments from different documents are not combined into the same batch.

Example:

".document_id"