Fluxos
Disparar Fluxo
Dispara um fluxo para um contato especifico. O fluxo precisa estar habilitado e a instancia conectada. Variaveis opcionais ficam disponiveis dentro do fluxo como {nome_da_variavel}. Ao chegar num bloco de webhook, todas as variaveis coletadas (respostas, cliques, dados do contato) sao enviadas para a URL configurada.
POST
https://api.zapzapapi.com/api/v1/flows/{flowId}/triggerAutenticação por cabeçalhos x-api-key e x-api-secret.
Parâmetros
| Nome | Tipo | Onde | Obrigatório | Descrição |
|---|---|---|---|---|
flowId | text | caminho | Sim | ID do fluxo |
instance_id | text | corpo | Sim | ID da instancia |
phone | text | corpo | Sim | Telefone do contato |
variables | json | corpo | Não | Variaveis iniciais (objeto JSON) |
Exemplo de requisição
curl
curl -X POST "https://api.zapzapapi.com/api/v1/flows/{flowId}/trigger" \
-H "x-api-key: SUA_API_KEY" \
-H "x-api-secret: SEU_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"instance_id":"inst-456","phone":"5511999999999"}'Node.js
const res = await fetch("https://api.zapzapapi.com/api/v1/flows/{flowId}/trigger", {
method: "POST",
headers: {
"x-api-key": "SUA_API_KEY",
"x-api-secret": "SEU_API_SECRET",
"Content-Type": "application/json",
},
body: JSON.stringify({
"instance_id": "inst-456",
"phone": "5511999999999"
}),
});
console.log(await res.json());Python
import requests
res = requests.post(
"https://api.zapzapapi.com/api/v1/flows/{flowId}/trigger",
headers={"x-api-key": "SUA_API_KEY", "x-api-secret": "SEU_API_SECRET"},
json={"instance_id":"inst-456","phone":"5511999999999"},
)
print(res.json())Exemplo de resposta
JSON
{
"execution_id": "exec-789",
"status": "waiting_reply",
"flow_id": "abc-123",
"phone": "5511999999999"
}Os valores são ilustrativos; os campos seguem o formato real da resposta.
Outros endpoints desta categoria
Pegue suas chaves de API
Crie sua conta, conecte um número em minutos e comece a usar a API. R$15 por número ativo/mês, com crédito de boas-vindas ao criar a conta, sujeito à campanha vigente.