Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vistum.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Eventos disponíveis

EventoDisparado quando
lead.createdUm novo lead é criado via API (POST /api/v1/leads)
contact.createdUm novo contato chega pelo WhatsApp
message.receivedUma mensagem é recebida de um contato
contact.tag_addedUma tag é adicionada a um contato
card.createdUm card é criado em um pipeline
card.movedUm card é movido entre etapas do pipeline
O evento test.ping é enviado pelo botão Ping nas configurações. Não aparece no histórico de deliveries como evento de negócio.

​
Estrutura do payload

Toda requisição de webhook tem a seguinte estrutura base. Os campos do evento são incluídos diretamente no objeto raiz — não há um envelope "data" separado. 
{
  "event": "lead.created",
  "workspace_id": "wks_abc123",
  "timestamp": "2025-05-07T14:30:00.000Z",
  "contact_id": "cnt_def456",
  "name": "João Ferreira",
  "phone": "5511999887766",
  "email": "joao@empresa.com"
}
Os headers incluem: 
X-Vistum-Event: lead.created
X-Vistum-Delivery: whk_xyz789
X-Vistum-Signature: t=1746666000,v1=a1b2c3d4e5f6...
Content-Type: application/json
User-Agent: Vistum-Webhooks/1.0
O campo de identificação do workspace é workspace_id (snake_case), não workspaceId.

​
Detalhes por evento

​
lead.created

Disparado quando um novo contato é criado via POST /api/v1/leads. 
{
  "event": "lead.created",
  "workspace_id": "wks_abc123",
  "timestamp": "2025-05-07T14:30:00.000Z",
  "contact_id": "cnt_def456",
  "name": "João Ferreira",
  "phone": "5511999887766",
  "email": "joao@empresa.com"
}

​
contact.created

Disparado quando um contato novo é criado manualmente no CRM. 
{
  "event": "contact.created",
  "workspace_id": "wks_abc123",
  "timestamp": "2025-05-07T14:30:00.000Z",
  "contact_id": "cnt_ghi789",
  "name": "Maria Costa",
  "phone": "5521988776655",
  "email": null
}

​
message.received

Disponível para subscrição. O dispatch deste evento será ativado em versão futura do CRM.
message.received já pode ser selecionado nas configurações de webhook, mas o disparo automático ainda não está ativo. Inscreva-se agora para receber os eventos quando forem habilitados.

​
contact.tag_added

Disponível para subscrição. O dispatch deste evento será ativado em versão futura do CRM.
contact.tag_added já pode ser selecionado nas configurações de webhook, mas o disparo automático ainda não está ativo.

​
card.created

Disparado quando um card é adicionado a um pipeline (pelo CRM ou pela API). 
{
  "event": "card.created",
  "workspace_id": "wks_abc123",
  "timestamp": "2025-05-07T14:30:00.000Z",
  "card_id": "card_mno345",
  "stage_id": "stage_stu901",
  "pipeline_id": "pipe_pqr678",
  "contact_id": "cnt_ghi789",
  "name": "João Ferreira"
}

​
card.moved

Disparado quando um card é movido para outra etapa do pipeline. 
{
  "event": "card.moved",
  "workspace_id": "wks_abc123",
  "timestamp": "2025-05-07T14:30:00.000Z",
  "card_id": "card_mno345",
  "from_stage_id": "stage_stu901",
  "to_stage_id": "stage_vwx234",
  "contact_id": "cnt_ghi789",
  "name": "João Ferreira"
}