Events
When an event occurs, we create a new Event object. For example, when an execution succeeds, we create an execution.completed event, and when an execution fails, we create an execution.failed event.
Event object
Id | Unique identifier of the event. |
|---|---|
Organization Id | Unique identifier of the organization. |
Data | Object containing data associated with the event. |
Data.EventType | Description of the event (for example, execution.completed or execution.failed). |
Timestamp | Time at which the object was created. |
JSON | Copy |
|---|---|
{ "id": "67b2fdb5dff937fd38272c2c", "organization_id": "641aae5b328566b887c424ff", "data": [ { "event_type": "execution.completed", "payload": { "workflow_id": "67a20c82cc406c7a8dbc4332", "execution_id": "67b2fd021843e6bcf9bd971b", "follow_up_execution_ids": [ "67b2fdacdff937fd38272c2a" ] } } ], "timestamp": "2025-02-18T00:00:00Z" } |
Event type
execution.completed: occurred when an execution completed
JSON | Copy |
|---|---|
{ "data": [ { "event_type": "execution.completed", "payload": { "workflow_id": "67a20c82cc406c7a8dbc4332", "execution_id": "67b2fd021843e6bcf9bd971b", "follow_up_execution_ids": [ "67b2fdacdff937fd38272c2a" ] } } ], ... } |
execution.cancelled: occurred when an execution cancelled
JSON | Copy |
|---|---|
{ "data": [ { "event_type": "execution.cancelled", "payload": { "workflow_id": "67a20c82cc406c7a8dbc4332", "execution_id": "67b2fd021843e6bcf9bd971b" } } ], ... } |
execution.failed: occurred when an execution failed
JSON | Copy |
|---|---|
{ "data": [ { "event_type": "execution.failed", "payload": { "workflow_id": "67a20c82cc406c7a8dbc4332", "execution_id": "67b2fd021843e6bcf9bd971b" } } ], ... } |