API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webhook Configs

Create Webhook Config

WebhookConfigResponse webhookConfigs().create(WebhookConfigCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v1/beta/webhook-configs

List Webhook Configs

List<WebhookConfigResponse> webhookConfigs().list(WebhookConfigListParamsparams = WebhookConfigListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/beta/webhook-configs

Get Webhook Config

WebhookConfigResponse webhookConfigs().retrieve(WebhookConfigRetrieveParamsparams = WebhookConfigRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

Update Webhook Config

WebhookConfigResponse webhookConfigs().update(WebhookConfigUpdateParamsparams = WebhookConfigUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

Delete Webhook Config

webhookConfigs().delete(WebhookConfigDeleteParamsparams = WebhookConfigDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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.

String webhookUrl

URL to receive webhook POST notifications.

Optional<List<WebhookEvent>> webhookEvents

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.cancelled")

BATCH_ERROR("batch.error")

BATCH_PENDING("batch.pending")

BATCH_RUNNING("batch.running")

BATCH_SUCCESS("batch.success")

CLASSIFY_CANCELLED("classify.cancelled")

CLASSIFY_ERROR("classify.error")

CLASSIFY_PARTIAL_SUCCESS("classify.partial_success")

CLASSIFY_PENDING("classify.pending")

CLASSIFY_RUNNING("classify.running")

CLASSIFY_SUCCESS("classify.success")

EXTRACT_CANCELLED("extract.cancelled")

EXTRACT_ERROR("extract.error")

EXTRACT_PARTIAL_SUCCESS("extract.partial_success")

EXTRACT_PENDING("extract.pending")

EXTRACT_SUCCESS("extract.success")

PARSE_CANCELLED("parse.cancelled")

PARSE_ERROR("parse.error")

PARSE_PARTIAL_SUCCESS("parse.partial_success")

PARSE_PENDING("parse.pending")

PARSE_RUNNING("parse.running")

PARSE_SUCCESS("parse.success")

SHEETS_CANCELLED("sheets.cancelled")

SHEETS_ERROR("sheets.error")

SHEETS_PARTIAL_SUCCESS("sheets.partial_success")

SHEETS_PENDING("sheets.pending")

SHEETS_SUCCESS("sheets.success")

SPLIT_CANCELLED("split.cancelled")

SPLIT_ERROR("split.error")

SPLIT_PENDING("split.pending")

SPLIT_PROCESSING("split.processing")

SPLIT_SUCCESS("split.success")

UNMAPPED_EVENT("unmapped_event")

Optional<WebhookHeaders> webhookHeaders

Custom HTTP headers sent with each webhook request.

Optional<WebhookOutputFormat> webhookOutputFormat

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

One of the following:

JSON("json")

STRING("string")

Optional<String> webhookSigningSecret

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.

String id

Unique identifier for the webhook configuration.

boolean hasSecret

Whether a signing secret is configured for this endpoint.

String tenantId

Owner tenant ID.

JsonValue; tenantType "project"constant"project"constant

Owner tenant type.

String webhookUrl

URL that receives webhook POST notifications.

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

Optional<List<WebhookEvent>> webhookEvents

Subscribed events (null = all events).

One of the following:

BATCH_CANCELLED("batch.cancelled")

BATCH_ERROR("batch.error")

BATCH_PENDING("batch.pending")

BATCH_RUNNING("batch.running")

BATCH_SUCCESS("batch.success")

CLASSIFY_CANCELLED("classify.cancelled")

CLASSIFY_ERROR("classify.error")

CLASSIFY_PARTIAL_SUCCESS("classify.partial_success")

CLASSIFY_PENDING("classify.pending")

CLASSIFY_RUNNING("classify.running")

CLASSIFY_SUCCESS("classify.success")

EXTRACT_CANCELLED("extract.cancelled")

EXTRACT_ERROR("extract.error")

EXTRACT_PARTIAL_SUCCESS("extract.partial_success")

EXTRACT_PENDING("extract.pending")

EXTRACT_SUCCESS("extract.success")

PARSE_CANCELLED("parse.cancelled")

PARSE_ERROR("parse.error")

PARSE_PARTIAL_SUCCESS("parse.partial_success")

PARSE_PENDING("parse.pending")

PARSE_RUNNING("parse.running")

PARSE_SUCCESS("parse.success")

SHEETS_CANCELLED("sheets.cancelled")

SHEETS_ERROR("sheets.error")

SHEETS_PARTIAL_SUCCESS("sheets.partial_success")

SHEETS_PENDING("sheets.pending")

SHEETS_SUCCESS("sheets.success")

SPLIT_CANCELLED("split.cancelled")

SPLIT_ERROR("split.error")

SPLIT_PENDING("split.pending")

SPLIT_PROCESSING("split.processing")

SPLIT_SUCCESS("split.success")

UNMAPPED_EVENT("unmapped_event")

Optional<WebhookHeaders> webhookHeaders

Custom HTTP headers sent with each request.

Optional<WebhookOutputFormat> webhookOutputFormat

Response format sent to the webhook.

One of the following:

JSON("json")

STRING("string")