Available webhooks

Configure webhooks to receive Zild events, including every Zild Docs document status change.

How they work

Webhooks notify your system when an event occurs in Zild. For each enabled registration, the platform sends a POST request with Content-Type: application/json to the configured URL. The request body depends on the event.

Create a webhook with POST /Webhook, provide an internet-accessible HTTPS URL, keep enable set to true, and select the numeric webhookType value.

{
  "enable": true,
  "name": "Document completed",
  "webhookType": 9,
  "url": "https://example.com/webhooks/zild"
}

Available events

Value	Event	When it is sent
`0`	`EvaluationResult`	When an evaluation result becomes available.
`2`	`ConversationEnded`	When a conversation ends.
`3`	`ConversationDeleted`	When a conversation is deleted.
`4`	`CallTransferred`	When a call is transferred.
`5`	`DocumentNew`	When a document is created with the `New` status.
`6`	`DocumentInProgress`	When processing changes to `InProgress`.
`7`	`DocumentTextExtracted`	When document text has been extracted.
`8`	`DocumentError`	When processing ends with an error.
`9`	`DocumentCompleted`	When processing completes.
`10`	`DocumentCancelled`	When processing is cancelled.

Document webhooks

The six document events follow the Zild Docs lifecycle. The payload is the Document object itself after its status is updated. Use Id as the idempotency key and DocumentStatusType to confirm the received state.

Status	Value	Matching event
`New`	`0`	`DocumentNew`
`InProgress`	`1`	`DocumentInProgress`
`TextExtracted`	`2`	`DocumentTextExtracted`
`Error`	`3`	`DocumentError`
`Completed`	`4`	`DocumentCompleted`
`Cancelled`	`5`	`DocumentCancelled`

Document payload example

{
  "Id": 123,
  "TenantId": 45,
  "Title": "Contract.pdf",
  "Description": null,
  "ExtractedText": "...",
  "QuantityPages": 8,
  "AnalysisText": "...",
  "FileUrl": "https://...",
  "DocumentStatusId": 0,
  "DocumentType": 2,
  "CreatedAt": "2026-09-23T12:00:00Z",
  "AnalizedAt": "2026-09-23T12:01:30Z",
  "DocumentChecklistId": 7,
  "Private": false,
  "CreatedByUserId": 18,
  "DocumentStatusType": 4
}

Fields may contain null depending on the processing stage. Do not use FileUrl, title, or date as a unique identifier.

Safe receiving

Respond quickly with a 2xx status and process long-running work asynchronously.
Handle repeated deliveries idempotently.
Restrict the URL to HTTPS and do not include secrets in it.
Log the document ID, event type, and time while avoiding unnecessary storage of sensitive content.
Monitor non-2xx responses from your endpoint.