Flujos

Disparar flujo

Dispara un flujo para un contacto específico. El flujo debe estar habilitado y la instancia conectada. Las variables opcionales quedan disponibles dentro del flujo como {nombre_de_la_variable}. Al llegar a un bloque de webhook, todas las variables recopiladas (respuestas, clics, datos del contacto) se envían a la URL configurada.

POSThttps://api.zapzapapi.com/api/v1/flows/{flowId}/trigger

Autenticación con los encabezados x-api-key y x-api-secret.

Parámetros

NombreTipoDóndeObligatorioDescripción
flowIdtextrutaSíID del flujo
instance_idtextcuerpoSíID de la instancia
phonetextcuerpoSíTeléfono del contacto
variablesjsoncuerpoNoVariables iniciales (objeto JSON)

Ejemplo de solicitud

curl

curl -X POST "https://api.zapzapapi.com/api/v1/flows/{flowId}/trigger" \
  -H "x-api-key: TU_API_KEY" \
  -H "x-api-secret: TU_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": "TU_API_KEY",
    "x-api-secret": "TU_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": "TU_API_KEY", "x-api-secret": "TU_API_SECRET"},
    json={"instance_id":"inst-456","phone":"5511999999999"},
)
print(res.json())

Ejemplo de respuesta

JSON

{
  "execution_id": "exec-789",
  "status": "waiting_reply",
  "flow_id": "abc-123",
  "phone": "5511999999999"
}

Los valores son ilustrativos; los campos siguen el formato real de la respuesta.

Otros endpoints de esta categoría

Ver la referencia completa

Consigue tus claves de API

Crea tu cuenta, conecta un número en minutos y empieza a usar la API. R$15 por número activo/mes, con un crédito de bienvenida al crear la cuenta, sujeto a la campaña vigente.