Pular para o conteúdo principal

Eventos

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": "…" }
}
CampoDescrição
eventNome do evento (o mesmo do cabeçalho X-Webhook-Event).
timestampMomento em que o evento aconteceu (ISO 8601, UTC).
dataDados 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​

EventoQuandoCampos em data
deal.createdNegócio criadoid, companyId, title, dealCode, dealType, status, totalDealAmount, customerId, pipelineStepId, createdAt
deal.updatedNegócio atualizadoid, companyId, title, dealCode, status, totalDealAmount
deal.status_changedStatus do negócio mudou, inclusive ao marcar como ganho ou perdidoid, companyId, title, previousStatus, newStatus
deal.deletedNegócio inativadoid, companyId

Não há eventos separados de "ganho" e "perdido": eles chegam em deal.status_changed, com newStatus igual a WINNER ou LOST.

Financeiro​

EventoQuandoCampos em data
financial_entry.createdLançamento criado (pela tela, pela API ou pela conciliação bancária)id, companyId, type, totalAmount, status, dueDate, personId
financial_entry.updatedLançamento atualizadoid, companyId, type, totalAmount, status, dueDate
financial_entry.paidLançamento liquidadoid, companyId, type, totalAmount, settledAt
financial_entry.deletedLançamento inativadoid, companyId

Cadastros​

EventoQuandoCampos em data
person.createdPessoa cadastradaid, companyId, name, documentNumber, personType
person.updatedCadastro atualizadoid, companyId, name, documentNumber, personType
person.deletedCadastro inativadoid, companyId, name

Em person.*, name é o nome de exibição (nome fantasia ou nome social).

Compras​

EventoQuandoCampos em data
purchase_order.createdPedido de compra criadoid, companyId, code, status, totalAmount
purchase_order.updatedPedido atualizadoid, companyId, code, status, totalAmount
purchase_order.status_changedStatus do pedido mudouid, companyId, code, previousStatus, newStatus

Projetos​

EventoQuandoCampos em data
project.createdProjeto criadoid, companyId, name
project.updatedProjeto atualizadoid, companyId, name, status
project.deletedProjeto inativadoid, companyId, name
project_task.createdTarefa criadaid, companyId, projectId, title, status
project_task.updatedTarefa atualizadaid, companyId, projectId, title, status
project_task.status_changedStatus da tarefa mudou (na edição ou ao mover de coluna no quadro)id, companyId, projectId, newStatus e, na edição, oldStatus

Agendamento​

EventoQuandoCampos em data
appointment.createdAgendamento criadoid, companyId, title, startDate, endDate, status
appointment.updatedAgendamento atualizadoid, companyId, title, startDate, endDate, status
appointment.canceledAgendamento canceladoid, companyId, title

Protocolo (documentos recebidos)​

EventoQuandoCampos em data
protocol.createdProtocolo abertoid, companyId, protocolNumber, channelId, status, senderEmail, senderName
protocol.processing.completedLeitura dos documentos concluídaid, companyId, protocolNumber, status
protocol.processing.failedLeitura dos documentos falhouid, companyId, protocolNumber, errorMessage
protocol.linkedProtocolo vinculado a um registroid, companyId, target, mode, linkedModule, linkedRecordId, linkedRecordType
protocol.unlinkedVínculo desfeitoid, 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​

EventoQuandoCampos em data
charge.createdCobrança gerada (inclusive as agendadas e as que nascem da nota fiscal)id, companyId, financialEntryId, amount, status, dueDate
charge.paidCobrança pagaid, companyId, financialEntryId, amount, status, paidAt

Aprovações​

EventoQuandoCampos em data
approval_request.createdSolicitação de aprovação abertaid, companyId, entityType, entityId
approval_request.approvedSolicitação aprovadaid, companyId, entityType, entityId, approvedBy
approval_request.rejectedSolicitação rejeitadaid, companyId, entityType, entityId, rejectedBy

Contratos​

EventoQuandoCampos em data
contract.createdContrato criadoid, companyId, code, status, customerId, startDate
contract.updatedContrato atualizadoid, companyId, code, status
contract.status_changedStatus mudou (renovação, cancelamento, suspensão e outras mudanças)id, companyId, code, previousStatus, newStatus
contract.renewedContrato renovadoid, companyId, code, newEndDate
contract.canceledContrato canceladoid, companyId, code
contract.suspendedContrato suspensoid, companyId, code

Renovar, cancelar ou suspender envia dois avisos: o evento específico e contract.status_changed.

Timesheet​

EventoQuandoCampos em data
timesheet.submittedPeríodo enviado para aprovaçãoid, companyId, status, totalHours
timesheet.approvedPeríodo aprovadoid, companyId, status
timesheet.rejectedPeríodo rejeitadoid, companyId, status, rejectionReason
timesheet.closedPeríodo fechadoid, companyId, status

Inbox (atendimento)​

EventoQuandoCampos em data
inbox_conversation.createdConversa nova aberta por mensagem recebidaid, channelType, contactId
inbox_conversation.resolvedConversa resolvidaid, status
inbox_conversation.assignedConversa atribuída a um atendenteid, agentId
inbox_message.receivedMensagem recebidaid, conversationId, content (primeiros 100 caracteres)
inbox_message.sentMensagem enviadaid, 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.

Ainda com dúvida?

A nossa equipe ajuda você a configurar e usar esse recurso.