Webhooks
Events
The Event object
Field | Description |
---|---|
eventId | string - Unique identifier for the event |
eventType | string - Type of the event that occurred (workflow_run.completed) |
payload | object - Contains the WorkflowRun object. See the WorkflowRun object for the shape. |
Here is what you can expect for a given incoming event:
Example Event
{
"eventId": "event_1234",
"eventType": "workflow_run.completed",
"payload": {
"object": "workflow_run",
"id": "workflow_run_1234"
// etc.
}
}
Event types
The following table outlines the various event types you can receive via webhooks:
Event Type | Description |
---|---|
workflow_run.completed | Triggered whenever a WorkflowRun is completed |
workflow_run.failed | Triggered whenever a WorkflowRun fails |
workflow_run.needs_review | Triggered whenever a WorkflowRun needs review* |
workflow_run.rejected | Triggered whenever a WorkflowRun is rejected from the Extend dashboard. More info |
workflow_run.step_run.processed | Triggered whenever a WorkflowStep is finished processing, e.g. extraction steps, etc. This can be useful for consuming incremental extractions for workflows with multiple AI steps to create streaming-like experiences. |
* Only triggered when the workflow is configured to have a HumanReview step in the Extend workflow builder.