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.New(ctx, params) (*WebhookConfigResponse, error)

POST/api/v1/beta/webhook-configs

List Webhook Configs

client.WebhookConfigs.List(ctx, query) (*[]WebhookConfigResponse, error)

GET/api/v1/beta/webhook-configs

Get Webhook Config

client.WebhookConfigs.Get(ctx, configID, query) (*WebhookConfigResponse, error)

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

Update Webhook Config

client.WebhookConfigs.Update(ctx, configID, params) (*WebhookConfigResponse, error)

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

Delete Webhook Config

client.WebhookConfigs.Delete(ctx, configID, body) error

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

ModelsExpand Collapse

type WebhookConfigCreate struct{…}

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.

WebhookURL string

URL to receive webhook POST notifications.

WebhookEvents []stringOptional

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

One of the following:

const WebhookConfigCreateWebhookEventBatchCancelled WebhookConfigCreateWebhookEvent = "batch.cancelled"

const WebhookConfigCreateWebhookEventBatchError WebhookConfigCreateWebhookEvent = "batch.error"

const WebhookConfigCreateWebhookEventBatchPending WebhookConfigCreateWebhookEvent = "batch.pending"

const WebhookConfigCreateWebhookEventBatchRunning WebhookConfigCreateWebhookEvent = "batch.running"

const WebhookConfigCreateWebhookEventBatchSuccess WebhookConfigCreateWebhookEvent = "batch.success"

const WebhookConfigCreateWebhookEventClassifyCancelled WebhookConfigCreateWebhookEvent = "classify.cancelled"

const WebhookConfigCreateWebhookEventClassifyError WebhookConfigCreateWebhookEvent = "classify.error"

const WebhookConfigCreateWebhookEventClassifyPartialSuccess WebhookConfigCreateWebhookEvent = "classify.partial_success"

const WebhookConfigCreateWebhookEventClassifyPending WebhookConfigCreateWebhookEvent = "classify.pending"

const WebhookConfigCreateWebhookEventClassifyRunning WebhookConfigCreateWebhookEvent = "classify.running"

const WebhookConfigCreateWebhookEventClassifySuccess WebhookConfigCreateWebhookEvent = "classify.success"

const WebhookConfigCreateWebhookEventExtractCancelled WebhookConfigCreateWebhookEvent = "extract.cancelled"

const WebhookConfigCreateWebhookEventExtractError WebhookConfigCreateWebhookEvent = "extract.error"

const WebhookConfigCreateWebhookEventExtractPartialSuccess WebhookConfigCreateWebhookEvent = "extract.partial_success"

const WebhookConfigCreateWebhookEventExtractPending WebhookConfigCreateWebhookEvent = "extract.pending"

const WebhookConfigCreateWebhookEventExtractSuccess WebhookConfigCreateWebhookEvent = "extract.success"

const WebhookConfigCreateWebhookEventParseCancelled WebhookConfigCreateWebhookEvent = "parse.cancelled"

const WebhookConfigCreateWebhookEventParseError WebhookConfigCreateWebhookEvent = "parse.error"

const WebhookConfigCreateWebhookEventParsePartialSuccess WebhookConfigCreateWebhookEvent = "parse.partial_success"

const WebhookConfigCreateWebhookEventParsePending WebhookConfigCreateWebhookEvent = "parse.pending"

const WebhookConfigCreateWebhookEventParseRunning WebhookConfigCreateWebhookEvent = "parse.running"

const WebhookConfigCreateWebhookEventParseSuccess WebhookConfigCreateWebhookEvent = "parse.success"

const WebhookConfigCreateWebhookEventSheetsCancelled WebhookConfigCreateWebhookEvent = "sheets.cancelled"

const WebhookConfigCreateWebhookEventSheetsError WebhookConfigCreateWebhookEvent = "sheets.error"

const WebhookConfigCreateWebhookEventSheetsPartialSuccess WebhookConfigCreateWebhookEvent = "sheets.partial_success"

const WebhookConfigCreateWebhookEventSheetsPending WebhookConfigCreateWebhookEvent = "sheets.pending"

const WebhookConfigCreateWebhookEventSheetsSuccess WebhookConfigCreateWebhookEvent = "sheets.success"

const WebhookConfigCreateWebhookEventSplitCancelled WebhookConfigCreateWebhookEvent = "split.cancelled"

const WebhookConfigCreateWebhookEventSplitError WebhookConfigCreateWebhookEvent = "split.error"

const WebhookConfigCreateWebhookEventSplitPending WebhookConfigCreateWebhookEvent = "split.pending"

const WebhookConfigCreateWebhookEventSplitProcessing WebhookConfigCreateWebhookEvent = "split.processing"

const WebhookConfigCreateWebhookEventSplitSuccess WebhookConfigCreateWebhookEvent = "split.success"

const WebhookConfigCreateWebhookEventUnmappedEvent WebhookConfigCreateWebhookEvent = "unmapped_event"

WebhookHeaders map[string, string]Optional

Custom HTTP headers sent with each webhook request.

WebhookOutputFormat WebhookConfigCreateWebhookOutputFormatOptional

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

One of the following:

const WebhookConfigCreateWebhookOutputFormatJson WebhookConfigCreateWebhookOutputFormat = "json"

const WebhookConfigCreateWebhookOutputFormatString WebhookConfigCreateWebhookOutputFormat = "string"

WebhookSigningSecret stringOptional

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

type WebhookConfigResponse struct{…}

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

ID string

Unique identifier for the webhook configuration.

HasSecret bool

Whether a signing secret is configured for this endpoint.

TenantID string

Owner tenant ID.

TenantType Project

Owner tenant type.

WebhookURL string

URL that receives webhook POST notifications.

CreatedAt TimeOptional

Creation datetime

formatdate-time

UpdatedAt TimeOptional

Update datetime

formatdate-time

WebhookEvents []stringOptional

Subscribed events (null = all events).

One of the following:

const WebhookConfigResponseWebhookEventBatchCancelled WebhookConfigResponseWebhookEvent = "batch.cancelled"

const WebhookConfigResponseWebhookEventBatchError WebhookConfigResponseWebhookEvent = "batch.error"

const WebhookConfigResponseWebhookEventBatchPending WebhookConfigResponseWebhookEvent = "batch.pending"

const WebhookConfigResponseWebhookEventBatchRunning WebhookConfigResponseWebhookEvent = "batch.running"

const WebhookConfigResponseWebhookEventBatchSuccess WebhookConfigResponseWebhookEvent = "batch.success"

const WebhookConfigResponseWebhookEventClassifyCancelled WebhookConfigResponseWebhookEvent = "classify.cancelled"

const WebhookConfigResponseWebhookEventClassifyError WebhookConfigResponseWebhookEvent = "classify.error"

const WebhookConfigResponseWebhookEventClassifyPartialSuccess WebhookConfigResponseWebhookEvent = "classify.partial_success"

const WebhookConfigResponseWebhookEventClassifyPending WebhookConfigResponseWebhookEvent = "classify.pending"

const WebhookConfigResponseWebhookEventClassifyRunning WebhookConfigResponseWebhookEvent = "classify.running"

const WebhookConfigResponseWebhookEventClassifySuccess WebhookConfigResponseWebhookEvent = "classify.success"

const WebhookConfigResponseWebhookEventExtractCancelled WebhookConfigResponseWebhookEvent = "extract.cancelled"

const WebhookConfigResponseWebhookEventExtractError WebhookConfigResponseWebhookEvent = "extract.error"

const WebhookConfigResponseWebhookEventExtractPartialSuccess WebhookConfigResponseWebhookEvent = "extract.partial_success"

const WebhookConfigResponseWebhookEventExtractPending WebhookConfigResponseWebhookEvent = "extract.pending"

const WebhookConfigResponseWebhookEventExtractSuccess WebhookConfigResponseWebhookEvent = "extract.success"

const WebhookConfigResponseWebhookEventParseCancelled WebhookConfigResponseWebhookEvent = "parse.cancelled"

const WebhookConfigResponseWebhookEventParseError WebhookConfigResponseWebhookEvent = "parse.error"

const WebhookConfigResponseWebhookEventParsePartialSuccess WebhookConfigResponseWebhookEvent = "parse.partial_success"

const WebhookConfigResponseWebhookEventParsePending WebhookConfigResponseWebhookEvent = "parse.pending"

const WebhookConfigResponseWebhookEventParseRunning WebhookConfigResponseWebhookEvent = "parse.running"

const WebhookConfigResponseWebhookEventParseSuccess WebhookConfigResponseWebhookEvent = "parse.success"

const WebhookConfigResponseWebhookEventSheetsCancelled WebhookConfigResponseWebhookEvent = "sheets.cancelled"

const WebhookConfigResponseWebhookEventSheetsError WebhookConfigResponseWebhookEvent = "sheets.error"

const WebhookConfigResponseWebhookEventSheetsPartialSuccess WebhookConfigResponseWebhookEvent = "sheets.partial_success"

const WebhookConfigResponseWebhookEventSheetsPending WebhookConfigResponseWebhookEvent = "sheets.pending"

const WebhookConfigResponseWebhookEventSheetsSuccess WebhookConfigResponseWebhookEvent = "sheets.success"

const WebhookConfigResponseWebhookEventSplitCancelled WebhookConfigResponseWebhookEvent = "split.cancelled"

const WebhookConfigResponseWebhookEventSplitError WebhookConfigResponseWebhookEvent = "split.error"

const WebhookConfigResponseWebhookEventSplitPending WebhookConfigResponseWebhookEvent = "split.pending"

const WebhookConfigResponseWebhookEventSplitProcessing WebhookConfigResponseWebhookEvent = "split.processing"

const WebhookConfigResponseWebhookEventSplitSuccess WebhookConfigResponseWebhookEvent = "split.success"

const WebhookConfigResponseWebhookEventUnmappedEvent WebhookConfigResponseWebhookEvent = "unmapped_event"

WebhookHeaders map[string, string]Optional

Custom HTTP headers sent with each request.

WebhookOutputFormat WebhookConfigResponseWebhookOutputFormatOptional

Response format sent to the webhook.

One of the following:

const WebhookConfigResponseWebhookOutputFormatJson WebhookConfigResponseWebhookOutputFormat = "json"

const WebhookConfigResponseWebhookOutputFormatString WebhookConfigResponseWebhookOutputFormat = "string"