Skip to main content

Batch Event Trigger

The Batch Event Trigger activity starts a workflow when a batch event occurs.

info

This activity acts as a batch event trigger. It must be the first step in a workflow.

Configuring the Batch Event Trigger Activity

To configure the Batch Event Trigger activity, fill in the required fields in the activity panel.

Configuration

FieldRequiredDescriptionExample
NameRequiredSpecify the name for this activity.MyActivity
DescriptionOptionalSpecify the description for this activity.Reads a file from S3
Auto AcknowledgeOptionalWhen enabled, delivery of this event will be acknowledged automatically. In case of failures, this event will not be redelivered.
RecordsOptionalRecords for this activity.

Output

FieldRequiredData TypeDescriptionExample
Batch IdOptionalStringBatchId for which this event was generated
Event TypeOptionalStringEventType for this trigger
ContextOptionalObjectContext that was provided in Init Batch
RecordOptionalObject