Catálogo de eventos
Os 23 tipos disponíveis, agrupados por família, e os curingas de assinatura.
Um endpoint assina eventos por tipo exato, por família inteira (familia.*) ou tudo (*). Por exemplo, assinar deal.* equivale a assinar deal.created, deal.stage_changed, deal.won e deal.lost ao mesmo tempo; um tipo novo que a Vensy adicionar depois dentro de uma família já assinada por curinga passa a chegar automaticamente.
message.*
| Evento | Quando dispara |
|---|---|
message.received | Mensagem inbound recebida em tempo real (não backfill). |
message.sent | Mensagem outbound enviada ao provedor. |
message.delivered | Mensagem outbound confirmada como entregue pelo provedor. |
message.read | Mensagem outbound confirmada como lida pelo contato. |
message.failed | Envio de mensagem falhou no provedor. |
conversation.*
| Evento | Quando dispara |
|---|---|
conversation.created | Nova conversa criada em tempo real (não backfill). |
conversation.assigned | Conversa atribuída a um agente. |
conversation.closed | Conversa encerrada. |
conversation.reopened | Conversa reaberta depois de encerrada. |
conversation.queued | Conversa voltou para a fila, sem atribuição. |
conversation.channel_changed | O canal da conversa foi trocado. |
contact.*
| Evento | Quando dispara |
|---|---|
contact.created | Novo contato criado no CRM. |
contact.updated | Campos do contato alterados — os valores anteriores vêm em data.previous. |
contact.archived | Contato arquivado. |
contact.deleted | Contato excluído. O payload traz só ids (LGPD), sem dados pessoais. |
data.object de contato segue o mesmo formato público usado pela API do CRM — os mesmos campos que você já recebe num GET /contacts/{id}.
deal.*
| Evento | Quando dispara |
|---|---|
deal.created | Novo negócio criado no funil do CRM. |
deal.stage_changed | Negócio mudou de etapa no funil. |
deal.won | Negócio marcado como ganho. |
deal.lost | Negócio marcado como perdido. |
data.object de negócio segue o mesmo formato público usado pela API do CRM (GET /deals/{id}).
channel.*
| Evento | Quando dispara |
|---|---|
channel.status_changed | O status de conexão do canal mudou (ex.: conectado, degradado, desconectado). |
data.object de canal traz os campos públicos do recurso canal (id, provedor, nome e status de conexão) — não é o mesmo formato detalhado usado internamente na tela de Canais.
campaign.*
| Evento | Quando dispara |
|---|---|
campaign.status_changed | Status da campanha mudou (ex.: pausada, retomada, concluída). |
campaign.lead_replied | Um lead da campanha respondeu. |
campaign.lead_failed | Um lead da campanha falhou ou foi pulado (envio ou validação). |
data.object de campanha e de lead de campanha traz os campos públicos desses recursos (id, status, motivo da pausa/falha quando houver).
Curingas
| Assinatura | Equivale a |
|---|---|
message.* | Todos os 5 eventos de message |
* | Todos os 23 eventos de todas as famílias |
Catálogo em runtime
A lista oficial e sempre atualizada está disponível em GET /api/v1/webhook-event-types (sessão) ou GET /api/v1/integrations/webhooks/event-types (API key) — use-a ao montar a tela de seleção de eventos na sua própria integração, em vez de fixar esta lista em código.