Chatbots

Gatilho por webhook

POSThttps://api.seudominio.com.br/integrations/hooks/chatbots/{id}/{token}

Inicia um chatbot a partir de qualquer sistema, sem token sk_.

Para formulários, landing pages e ferramentas que só sabem “chamar uma URL”. Copie a URL no gatilho Webhook do chatbot de automação — o token do caminho é a autenticação, então trate a URL como segredo.

O corpo pode ter qualquer JSON (até 64 KB): o telefone é lido de telefone, phone, phone_number, whatsapp ou celular, e o nome de nome ou name. O objeto inteiro fica disponível no fluxo como webhook.* (ex.: {{webhook.plano}}).

Este caminho fica fora de /integrations/v1 e tem limite próprio de 120 chamadas por minuto por IP.

Sem token sk_

Este endereço não usa o header Authorization: o token no caminho é a credencial. Não publique a URL em código que roda no navegador do visitante.

Parâmetros de caminho

idstring (uuid)obrigatório

Id do chatbot.

tokenstringobrigatório

Token do gatilho, gerado no editor do chatbot.

Corpo da requisição

application/json

telefonestring (telefone)obrigatório

Telefone do contato (ou phone, phone_number, whatsapp, celular).

nomestring

Nome do contato (ou name).

Corpo para testar

Respostas

AnteriorIniciar chatbot Próximo Assinar eventos

curl --request POST \
  --url 'https://api.seudominio.com.br/integrations/hooks/chatbots/{id}/{token}' \
  --header 'Content-Type: application/json' \
  --data '{
  "telefone": "11999990000",
  "nome": "Maria",
  "plano": "Premium",
  "origem": "landing-page"
}'

A chamada é real: age sobre os dados do seu workspace.

Resposta

{
  "ok": true,
  "conversation_id": 120,
  "contact_id": 35
}