Vensy Developers
Webhooks de eventos

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.*

EventoQuando dispara
message.receivedMensagem inbound recebida em tempo real (não backfill).
message.sentMensagem outbound enviada ao provedor.
message.deliveredMensagem outbound confirmada como entregue pelo provedor.
message.readMensagem outbound confirmada como lida pelo contato.
message.failedEnvio de mensagem falhou no provedor.

conversation.*

EventoQuando dispara
conversation.createdNova conversa criada em tempo real (não backfill).
conversation.assignedConversa atribuída a um agente.
conversation.closedConversa encerrada.
conversation.reopenedConversa reaberta depois de encerrada.
conversation.queuedConversa voltou para a fila, sem atribuição.
conversation.channel_changedO canal da conversa foi trocado.

contact.*

EventoQuando dispara
contact.createdNovo contato criado no CRM.
contact.updatedCampos do contato alterados — os valores anteriores vêm em data.previous.
contact.archivedContato arquivado.
contact.deletedContato 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.*

EventoQuando dispara
deal.createdNovo negócio criado no funil do CRM.
deal.stage_changedNegócio mudou de etapa no funil.
deal.wonNegócio marcado como ganho.
deal.lostNegócio marcado como perdido.

data.object de negócio segue o mesmo formato público usado pela API do CRM (GET /deals/{id}).

channel.*

EventoQuando dispara
channel.status_changedO 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.*

EventoQuando dispara
campaign.status_changedStatus da campanha mudou (ex.: pausada, retomada, concluída).
campaign.lead_repliedUm lead da campanha respondeu.
campaign.lead_failedUm 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

AssinaturaEquivale 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.

Nesta página