API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webhook Configs

Create Webhook Config

webhook_configs.create(WebhookConfigCreateParams**kwargs) -> WebhookConfigResponse

POST/api/v1/beta/webhook-configs

List Webhook Configs

webhook_configs.list(WebhookConfigListParams**kwargs) -> WebhookConfigListResponse

GET/api/v1/beta/webhook-configs

Get Webhook Config

webhook_configs.retrieve(strconfig_id, WebhookConfigRetrieveParams**kwargs) -> WebhookConfigResponse

GET/api/v1/beta/webhook-configs/{config_id}

Update Webhook Config

webhook_configs.update(strconfig_id, WebhookConfigUpdateParams**kwargs) -> WebhookConfigResponse

PUT/api/v1/beta/webhook-configs/{config_id}

Delete Webhook Config

webhook_configs.delete(strconfig_id, WebhookConfigDeleteParams**kwargs)

DELETE/api/v1/beta/webhook-configs/{config_id}

ModelsExpand Collapse

class WebhookConfigCreate: …

Request to create a stored webhook configuration.

The owning tenant is taken from the request context (e.g. the project in the path), not the body.

webhook_url: str

URL to receive webhook POST notifications.

webhook_events: Optional[List[Literal["batch.cancelled", "batch.error", "batch.pending", 30 more]]]

Events to subscribe to. If null, all events are delivered. An empty list subscribes to nothing and is rejected.

One of the following:

"batch.cancelled"

"batch.error"

"batch.pending"

"batch.running"

"batch.success"

"classify.cancelled"

"classify.error"

"classify.partial_success"

"classify.pending"

"classify.running"

"classify.success"

"extract.cancelled"

"extract.error"

"extract.partial_success"

"extract.pending"

"extract.success"

"parse.cancelled"

"parse.error"

"parse.partial_success"

"parse.pending"

"parse.running"

"parse.success"

"sheets.cancelled"

"sheets.error"

"sheets.partial_success"

"sheets.pending"

"sheets.success"

"split.cancelled"

"split.error"

"split.pending"

"split.processing"

"split.success"

"unmapped_event"

webhook_headers: Optional[Dict[str, str]]

Custom HTTP headers sent with each webhook request.

webhook_output_format: Optional[Literal["json", "string"]]

Response format sent to the webhook: ‘string’ (default) or ‘json’.

One of the following:

"json"

"string"

webhook_signing_secret: Optional[str]

Shared secret used to sign deliveries to this endpoint. Write-only: it is never returned in responses.

class WebhookConfigResponse: …

A stored webhook configuration. The signing secret is never included.

id: str

Unique identifier for the webhook configuration.

has_secret: bool

Whether a signing secret is configured for this endpoint.

tenant_id: str

Owner tenant ID.

tenant_type: Literal["project"]

Owner tenant type.

webhook_url: str

URL that receives webhook POST notifications.

created_at: Optional[datetime]

Creation datetime

formatdate-time

updated_at: Optional[datetime]

Update datetime

formatdate-time

webhook_events: Optional[List[Literal["batch.cancelled", "batch.error", "batch.pending", 30 more]]]

Subscribed events (null = all events).

One of the following:

"batch.cancelled"

"batch.error"

"batch.pending"

"batch.running"

"batch.success"

"classify.cancelled"

"classify.error"

"classify.partial_success"

"classify.pending"

"classify.running"

"classify.success"

"extract.cancelled"

"extract.error"

"extract.partial_success"

"extract.pending"

"extract.success"

"parse.cancelled"

"parse.error"

"parse.partial_success"

"parse.pending"

"parse.running"

"parse.success"

"sheets.cancelled"

"sheets.error"

"sheets.partial_success"

"sheets.pending"

"sheets.success"

"split.cancelled"

"split.error"

"split.pending"

"split.processing"

"split.success"

"unmapped_event"

webhook_headers: Optional[Dict[str, str]]

Custom HTTP headers sent with each request.

webhook_output_format: Optional[Literal["json", "string"]]

Response format sent to the webhook.

One of the following:

"json"

"string"

List[WebhookConfigResponse]

id: str

Unique identifier for the webhook configuration.

has_secret: bool

Whether a signing secret is configured for this endpoint.

tenant_id: str

Owner tenant ID.

tenant_type: Literal["project"]

Owner tenant type.

webhook_url: str

URL that receives webhook POST notifications.

created_at: Optional[datetime]

Creation datetime

formatdate-time

updated_at: Optional[datetime]

Update datetime

formatdate-time

webhook_events: Optional[List[Literal["batch.cancelled", "batch.error", "batch.pending", 30 more]]]

Subscribed events (null = all events).

One of the following:

"batch.cancelled"

"batch.error"

"batch.pending"

"batch.running"

"batch.success"

"classify.cancelled"

"classify.error"

"classify.partial_success"

"classify.pending"

"classify.running"

"classify.success"

"extract.cancelled"

"extract.error"

"extract.partial_success"

"extract.pending"

"extract.success"

"parse.cancelled"

"parse.error"

"parse.partial_success"

"parse.pending"

"parse.running"

"parse.success"

"sheets.cancelled"

"sheets.error"

"sheets.partial_success"

"sheets.pending"

"sheets.success"

"split.cancelled"

"split.error"

"split.pending"

"split.processing"

"split.success"

"unmapped_event"

webhook_headers: Optional[Dict[str, str]]

Custom HTTP headers sent with each request.

webhook_output_format: Optional[Literal["json", "string"]]

Response format sent to the webhook.

One of the following:

"json"

"string"