Webhooks

Create a webhook

post/v1/webhooks

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required
secretstring

HMAC signing secret (defaults to empty).

eventsstring[]

Event types to subscribe to (default: extraction.complete, extraction.failed). Includes run.completed / run.failed — fired on POST /v1/run pipeline completion. run.completed's payload carries records (array of { document_id, filename, data }, always present; document_id and filename are nullable — null when a row's document identity cannot be resolved) alongside the legacy structured_data; run.failed's error object may carry document_ids (best effort, present on some failure paths only). See GET /v1/webhooks/events for the full, current catalog.

source_connection_idstring uuid nullable
is_activeboolean

Response

Created webhook

Changes

No recorded changes to this operation across all 1 revision of this API.