VendeeDocs

Webhooks

Receba eventos do CRM em tempo real na sua aplicação — em breve.

Em breve. Os webhooks estão em finalização e disponíveis apenas no ambiente de testes. O contrato (eventos, payloads e verificação de assinatura) ainda pode mudar antes do lançamento público — não construa integrações de produção sobre ele ainda.

Os webhooks vão permitir que o Vendee notifique a sua aplicação quando algo acontece no CRM, sem você precisar ficar consultando a API. Você registra uma URL de destino e o CRM envia um POST para ela a cada evento assinado.

O que está previsto

  • Assinaturas por API Key — uma chave com escopo webhooks:manage registra, lista e remove assinaturas, escolhendo quais eventos quer receber.
  • Catálogo de eventos — eventos do ciclo de vida de negócios e atividades, como mudança de etapa, ganho, perda e atividades criadas/atrasadas.
  • Entrega segura — cada assinatura recebe um secret (exibido uma única vez) usado para assinar as entregas (HMAC), permitindo que você verifique que o webhook veio mesmo do Vendee. URLs de destino precisam ser HTTPS e públicas.

Esta página será atualizada com os eventos, os payloads de exemplo e o trecho de verificação da assinatura quando os webhooks forem liberados. Acompanhe o Changelog.

Nesta página