Skip to main content

​
Estrutura do Payload do Webhook

Cada webhook entrega um payload completo e estruturado com todas as informações relevantes da task, eliminando a necessidade de fazer chamadas adicionais à API.

​
Exemplo de Payload Completo

{
  "id": "unique-webhook-id",
  "event": "task.completed",
  "timestamp": "2025-10-16T12:00:00Z",
  "task": {
    "id": "task-uuid",
    "title": "Análise de Contrato",
    "description": "Revisão de cláusulas contratuais",
    "status": "completed",
    "reference": 1234,
    // ... metadados completos da task
  },
  "inputContent": {
    "files": [
      {
        "filename": "contrato.pdf",
        "content": "conteúdo processado e extraído",
        "type": "application/pdf"
      }
    ]
  },
  "outputContent": "Análise completa com todas as cláusulas identificadas..."
}

​
Referência de Campos

​
id
string
required
Identificador único da notificação (útil para deduplicação)
​
event
string
required
Qual evento disparou este webhook. Valores possíveis:
  • task.completed - Task finalizada e pronta para revisão
  • task.approved - Task aprovada
​
timestamp
string
required
Momento exato em que o evento ocorreu (formato ISO 8601)
​
task
object
required
Dados completos da task incluindo:
  • id (string) - Identificador único da task
  • title (string) - Título da task
  • description (string) - Descrição da task
  • status (string) - Status atual da task
  • reference (number) - Número de referência legível da task
  • Metadados adicionais
​
inputContent
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
​
outputContent
string
O resultado completo gerado pela task

​
Próximos Passos

Visão Geral

Conheça Events e webhooks

Configuração

Configure webhooks no seu app

Autenticação

Proteja suas integrações webhook
⌘I