Webhooks disponíveis

Configure webhooks para receber eventos da Zild, incluindo todas as mudanças de status de documentos no Zild Docs.

Como funcionam

Webhooks notificam seu sistema quando um evento ocorre na Zild. Para cada cadastro habilitado, a plataforma envia uma requisição POST com Content-Type: application/json para a URL configurada. O corpo varia conforme o evento.

Cadastre um webhook com POST /Webhook, informe uma URL HTTPS acessível pela internet, mantenha enable como true e selecione o valor numérico de webhookType.

{
  "enable": true,
  "name": "Documento concluído",
  "webhookType": 9,
  "url": "https://example.com/webhooks/zild"
}

Eventos disponíveis

Valor	Evento	Quando é enviado
`0`	`EvaluationResult`	Quando um resultado de avaliação fica disponível.
`2`	`ConversationEnded`	Quando uma conversa é encerrada.
`3`	`ConversationDeleted`	Quando uma conversa é excluída.
`4`	`CallTransferred`	Quando uma chamada é transferida.
`5`	`DocumentNew`	Quando um documento é criado com status `New`.
`6`	`DocumentInProgress`	Quando o processamento muda para `InProgress`.
`7`	`DocumentTextExtracted`	Quando o texto do documento foi extraído.
`8`	`DocumentError`	Quando o processamento termina com erro.
`9`	`DocumentCompleted`	Quando o processamento é concluído.
`10`	`DocumentCancelled`	Quando o processamento é cancelado.

Webhooks de documentos

Os seis eventos de documento acompanham o ciclo de vida do Zild Docs. O payload é o próprio objeto Document após a atualização de status. Use Id como chave de idempotência e DocumentStatusType para confirmar o estado recebido.

Status	Valor	Evento correspondente
`New`	`0`	`DocumentNew`
`InProgress`	`1`	`DocumentInProgress`
`TextExtracted`	`2`	`DocumentTextExtracted`
`Error`	`3`	`DocumentError`
`Completed`	`4`	`DocumentCompleted`
`Cancelled`	`5`	`DocumentCancelled`

Exemplo de payload de documento

{
  "Id": 123,
  "TenantId": 45,
  "Title": "Contrato.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
}

Os campos podem conter null conforme a etapa de processamento. Não use FileUrl, título ou data como identificador único.

Recebimento seguro

Responda rapidamente com um status 2xx e processe trabalhos demorados de forma assíncrona.
Trate entregas repetidas de forma idempotente.
Restrinja a URL a HTTPS e não inclua segredos nela.
Registre o ID do documento, o tipo de evento e o horário, evitando persistir conteúdo sensível sem necessidade.
Monitore respostas não 2xx no seu endpoint.