Todo aviso tem o formato abaixo. O que muda de um evento para outro é o conteúdo de data.
{
"event": "person.created",
"timestamp": "2026-11-17T14:30:00.000Z",
"data": { "id": "6a1f3c9e8b2d4f0a1c3e5b7d", "companyId": "…" }
}
| Campo | Descrição |
|---|
event | Nome do evento (o mesmo do cabeçalho X-Webhook-Event). |
timestamp | Momento em que o evento aconteceu (ISO 8601, UTC). |
data | Dados principais do registro. Sempre traz o id do registro (ou do protocolo) e, na maioria dos eventos, companyId. |
data não traz o registro inteiro. Se precisar de mais campos, busque o registro pela API com o id recebido.
Ao assinar, você pode escolher eventos um a um ou usar o curinga da categoria (por exemplo, deal.*), que inclui os eventos que forem criados depois. O curinga pode trazer eventos adicionais do mesmo grupo, além dos listados nesta página: a sua integração deve ignorar os eventos que não conhece.
CRM
| Evento | Quando | Campos em data |
|---|
deal.created | Negócio criado | id, companyId, title, dealCode, dealType, status, totalDealAmount, customerId, pipelineStepId, createdAt |
deal.updated | Negócio atualizado | id, companyId, title, dealCode, status, totalDealAmount |
deal.status_changed | Status do negócio mudou, inclusive ao marcar como ganho ou perdido | id, companyId, title, previousStatus, newStatus |
deal.deleted | Negócio inativado | id, companyId |
Não há eventos separados de "ganho" e "perdido": eles chegam em deal.status_changed, com newStatus igual a WINNER ou LOST.
Financeiro
| Evento | Quando | Campos em data |
|---|
financial_entry.created | Lançamento criado (pela tela, pela API ou pela conciliação bancária) | id, companyId, type, totalAmount, status, dueDate, personId |
financial_entry.updated | Lançamento atualizado | id, companyId, type, totalAmount, status, dueDate |
financial_entry.paid | Lançamento liquidado | id, companyId, type, totalAmount, settledAt |
financial_entry.deleted | Lançamento inativado | id, companyId |
Cadastros
| Evento | Quando | Campos em data |
|---|
person.created | Pessoa cadastrada | id, companyId, name, documentNumber, personType |
person.updated | Cadastro atualizado | id, companyId, name, documentNumber, personType |
person.deleted | Cadastro inativado | id, companyId, name |
Em person.*, name é o nome de exibição (nome fantasia ou nome social).
Compras
| Evento | Quando | Campos em data |
|---|
purchase_order.created | Pedido de compra criado | id, companyId, code, status, totalAmount |
purchase_order.updated | Pedido atualizado | id, companyId, code, status, totalAmount |
purchase_order.status_changed | Status do pedido mudou | id, companyId, code, previousStatus, newStatus |
Projetos
| Evento | Quando | Campos em data |
|---|
project.created | Projeto criado | id, companyId, name |
project.updated | Projeto atualizado | id, companyId, name, status |
project.deleted | Projeto inativado | id, companyId, name |
project_task.created | Tarefa criada | id, companyId, projectId, title, status |
project_task.updated | Tarefa atualizada | id, companyId, projectId, title, status |
project_task.status_changed | Status da tarefa mudou (na edição ou ao mover de coluna no quadro) | id, companyId, projectId, newStatus e, na edição, oldStatus |
Agendamento
| Evento | Quando | Campos em data |
|---|
appointment.created | Agendamento criado | id, companyId, title, startDate, endDate, status |
appointment.updated | Agendamento atualizado | id, companyId, title, startDate, endDate, status |
appointment.canceled | Agendamento cancelado | id, companyId, title |
Protocolo (documentos recebidos)
| Evento | Quando | Campos em data |
|---|
protocol.created | Protocolo aberto | id, companyId, protocolNumber, channelId, status, senderEmail, senderName |
protocol.processing.completed | Leitura dos documentos concluída | id, companyId, protocolNumber, status |
protocol.processing.failed | Leitura dos documentos falhou | id, companyId, protocolNumber, errorMessage |
protocol.linked | Protocolo vinculado a um registro | id, companyId, target, mode, linkedModule, linkedRecordId, linkedRecordType |
protocol.unlinked | Vínculo desfeito | id, companyId |
Quem assina protocol.* também recebe protocol.document.updated (dados extraídos de um documento editados), com protocolId, documentId, companyId, extractedData e editedBy.
Cobranças
| Evento | Quando | Campos em data |
|---|
charge.created | Cobrança gerada (inclusive as agendadas e as que nascem da nota fiscal) | id, companyId, financialEntryId, amount, status, dueDate |
charge.paid | Cobrança paga | id, companyId, financialEntryId, amount, status, paidAt |
Aprovações
| Evento | Quando | Campos em data |
|---|
approval_request.created | Solicitação de aprovação aberta | id, companyId, entityType, entityId |
approval_request.approved | Solicitação aprovada | id, companyId, entityType, entityId, approvedBy |
approval_request.rejected | Solicitação rejeitada | id, companyId, entityType, entityId, rejectedBy |
Contratos
| Evento | Quando | Campos em data |
|---|
contract.created | Contrato criado | id, companyId, code, status, customerId, startDate |
contract.updated | Contrato atualizado | id, companyId, code, status |
contract.status_changed | Status mudou (renovação, cancelamento, suspensão e outras mudanças) | id, companyId, code, previousStatus, newStatus |
contract.renewed | Contrato renovado | id, companyId, code, newEndDate |
contract.canceled | Contrato cancelado | id, companyId, code |
contract.suspended | Contrato suspenso | id, companyId, code |
Renovar, cancelar ou suspender envia dois avisos: o evento específico e contract.status_changed.
Timesheet
| Evento | Quando | Campos em data |
|---|
timesheet.submitted | Período enviado para aprovação | id, companyId, status, totalHours |
timesheet.approved | Período aprovado | id, companyId, status |
timesheet.rejected | Período rejeitado | id, companyId, status, rejectionReason |
timesheet.closed | Período fechado | id, companyId, status |
Inbox (atendimento)
| Evento | Quando | Campos em data |
|---|
inbox_conversation.created | Conversa nova aberta por mensagem recebida | id, channelType, contactId |
inbox_conversation.resolved | Conversa resolvida | id, status |
inbox_conversation.assigned | Conversa atribuída a um atendente | id, agentId |
inbox_message.received | Mensagem recebida | id, conversationId, content (primeiros 100 caracteres) |
inbox_message.sent | Mensagem enviada | id, conversationId, content (primeiros 100 caracteres) |
Quem assina inbox_conversation.* também recebe inbox_conversation.updated (com id e os campos alterados) e inbox_conversation.entity_linked (com id, linkedEntityType e linkedEntityId). Os eventos do inbox não trazem companyId em data.