API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webhook Configs

Create Webhook Config

client.webhookConfigs.create(WebhookConfigCreateParams { webhook_url, organization_id, project_id, 4 more } params, RequestOptionsoptions?): WebhookConfigResponse { id, has_secret, tenant_id, 7 more }

POST/api/v1/beta/webhook-configs

List Webhook Configs

client.webhookConfigs.list(WebhookConfigListParams { organization_id, project_id } query?, RequestOptionsoptions?): WebhookConfigListResponse { id, has_secret, tenant_id, 7 more }

GET/api/v1/beta/webhook-configs

Get Webhook Config

client.webhookConfigs.retrieve(stringconfigID, WebhookConfigRetrieveParams { organization_id, project_id } query?, RequestOptionsoptions?): WebhookConfigResponse { id, has_secret, tenant_id, 7 more }

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

Update Webhook Config

client.webhookConfigs.update(stringconfigID, WebhookConfigUpdateParams { organization_id, project_id, webhook_events, 4 more } params, RequestOptionsoptions?): WebhookConfigResponse { id, has_secret, tenant_id, 7 more }

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

Delete Webhook Config

client.webhookConfigs.delete(stringconfigID, WebhookConfigDeleteParams { organization_id, project_id } params?, RequestOptionsoptions?): void

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

ModelsExpand Collapse

WebhookConfigCreate { webhook_url, webhook_events, webhook_headers, 2 more }

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: string

URL to receive webhook POST notifications.

webhook_events?: Array<"batch.cancelled" | "batch.error" | "batch.pending" | 30 more> | null

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?: Record<string, string> | null

Custom HTTP headers sent with each webhook request.

webhook_output_format?: "json" | "string" | null

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

One of the following:

"json"

"string"

webhook_signing_secret?: string | null

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

WebhookConfigResponse { id, has_secret, tenant_id, 7 more }

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

id: string

Unique identifier for the webhook configuration.

has_secret: boolean

Whether a signing secret is configured for this endpoint.

tenant_id: string

Owner tenant ID.

tenant_type: "project"

Owner tenant type.

webhook_url: string

URL that receives webhook POST notifications.

created_at?: string | null

Creation datetime

formatdate-time

updated_at?: string | null

Update datetime

formatdate-time

webhook_events?: Array<"batch.cancelled" | "batch.error" | "batch.pending" | 30 more> | null

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?: Record<string, string> | null

Custom HTTP headers sent with each request.

webhook_output_format?: "json" | "string" | null

Response format sent to the webhook.

One of the following:

"json"

"string"

WebhookConfigListResponse = Array<WebhookConfigResponse { id, has_secret, tenant_id, 7 more } >

id: string

Unique identifier for the webhook configuration.

has_secret: boolean

Whether a signing secret is configured for this endpoint.

tenant_id: string

Owner tenant ID.

tenant_type: "project"

Owner tenant type.

webhook_url: string

URL that receives webhook POST notifications.

created_at?: string | null

Creation datetime

formatdate-time

updated_at?: string | null

Update datetime

formatdate-time

webhook_events?: Array<"batch.cancelled" | "batch.error" | "batch.pending" | 30 more> | null

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?: Record<string, string> | null

Custom HTTP headers sent with each request.

webhook_output_format?: "json" | "string" | null

Response format sent to the webhook.

One of the following:

"json"

"string"