run.failed

Event triggered whenever an extraction run fails due to an error.

This event is triggered when there are issues such as unsupported file formats, parsing failures, or internal processing errors.

Response Body Parameters

type string

The event type that triggered the webhook (e.g., `run.failed`).

created_at string

ISO 8601 timestamp when the webhook event was created.

data object

Event-specific data containing the failure details.

properties

run_id string

Unique identifier for the extraction run.

document_id string

ID of the document that was processed.

schema_key string

Schema key used for extraction.

schema_version_number number

Version number of the schema used.

status string

Run status (`failed` or `validation_failed`).

error_message string

Description of what went wrong.

workspace_slug string

Slug of the workspace.

environment string

Environment slug.

200 Response

{
  "type": "run.failed",
  "created_at": "2024-03-15T10:30:15Z",
  "data": {
    "run_id": "run_xyz789",
    "document_id": "doc_abc123",
    "schema_key": "invoice",
    "schema_version_number": 3,
    "status": "failed",
    "error_message": "Unable to parse document content",
    "workspace_slug": "my-workspace",
    "environment": "production"
  }
}