Pular para o conteúdo principal

Estrutura do Payload do Webhook

Cada webhook entrega um payload completo e estruturado com todas as informações relevantes da tarefa, sem que você precise fazer chamadas adicionais à API.

Exemplo de Payload Completo

Referência de Campos

string
obrigatório
Identificador único da notificação (útil para evitar duplicidade)
string
obrigatório
Qual evento disparou este webhook. Valores possíveis:
  • task.completed - Tarefa finalizada e pronta para revisão
  • task.approved - Tarefa aprovada
string
obrigatório
Momento exato em que o evento ocorreu (formato ISO 8601)
object
obrigatório
Dados completos da tarefa, incluindo:
  • id (string) - Identificador único da tarefa
  • title (string) - Título da tarefa
  • description (string) - Descrição da tarefa
  • status (string) - Status atual da tarefa
  • reference (number) - Número de referência legível da tarefa
  • Metadados adicionais
object
Todo o conteúdo de entrada que foi processado:
  • files (array) - Array de arquivos processados com:
    • filename (string) - Nome original do arquivo
    • content (string) - Conteúdo processado e extraído
    • type (string) - Tipo MIME do arquivo
  • Dados de entrada adicionais
string
O resultado completo gerado pela tarefa

Próximos Passos

Visão Geral

Conheça os Eventos e os webhooks

Configuração

Configure webhooks no seu app

Autenticação

Proteja suas integrações webhook