Webhook Events

The Event object

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

{
  "eventId": "event_1234",
  "eventType": "workflow_run.completed",
  "payload": {
    "object": "workflow_run",
    "id": "workflow_run_1234"
    // etc.
  }
}

{
  "eventId": "event_1234",
  "eventType": "workflow_run.completed",
  "payload": {
    "data": "<signed download URL here>"
  }
}

Workflow 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.

Workflow global events

Run event types

The following tables outline the event types you can receive via webhook for runs created using the API.

Extract run events

Classify run events

Split run events

Batch processor run events

Applies to batch extract, classify, and split operations.

Batch parse run events

Applies to batch parse operations created via POST /parse_runs/batch.

Parse run events

Edit and form detection run events

Processor event types

The following tables outline event types for processor (extractor, classifier, splitter) lifecycle events.

Extractor events

Classifier events

Splitter events