Events

The Event object

Here is what you can expect for a given incoming event:

1
{
2
  "eventId": "event_1234",
3
  "eventType": "workflow_run.completed",
4
  "payload": {
5
    "object": "workflow_run",
6
    "id": "workflow_run_1234"
7
    // etc.
8
  }
9
}

1
{
2
  "eventId": "event_1234",
3
  "eventType": "workflow_run.completed",
4
  "payload": {
5
    "data": "<signed download URL here>"
6
  }
7
}

Workflow specific event types

The following table outlines the various event types you can receive via webhooks for a given workflow after you have created a webhook endpoint and subscribed to the desired event types.

* Only triggered when the workflow is configured to have a HumanReview step in the Extend workflow builder.

Processor run specific event types

The following table outlines the event types you can receive via webhook for a given processor run that you have created using the API after you have created a webhook endpoint and subscribed to the desired event types.

Global event types

The following table outlines the various event types you can receive via webhooks for your workspace as a whole after you have created a webhook endpoint and subscribed to the desired global event types.