Disparar evento da API para os Workflows
Rota de Workflows da API aberta da Astrify Flows: parâmetros, exemplos em curl, Node.js e Python, resposta e erros.
POSThttps://api2.astrify.com.br/v1/workflows/eventos
Escopo: workflows:write · Área: Workflows · Testar no navegador
{evento, lead_id | email, dados?} — dispara os Workflows cujo gatilho é "Evento da API" com esse nome (ou sem nome definido).
No Workflow use o gatilho “Evento enviado pela API”. disparado: false = nenhum Workflow ativo escuta esse evento.
Corpo
JSON, com o cabeçalho Content-Type: application/json.
| Campo | Tipo | Descrição |
|---|---|---|
evento obrigatório | string | 1–60 caracteres minúsculos: letras, números, _, ., - |
lead_id | uuid | Lead alvo (ou use email) |
email | string | E-mail do lead |
dados | object | Até 20 KB; chega nas variáveis api_evento e api_dados |
Exemplo de requisição
A chave vem da variável de ambiente ASTRIFY_API_KEY. Troque os marcadores em maiúsculas (comoLEAD_ID) por ids da sua empresa.
curl -X POST "https://api2.astrify.com.br/v1/workflows/eventos" \ -H "Authorization: Bearer $ASTRIFY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "evento": "pedido_pago", "email": "ana@exemplo.com", "dados": { "pedido": 1234, "valor": 199.9 }}'const res = await fetch('https://api2.astrify.com.br/v1/workflows/eventos', { method: 'POST', headers: { Authorization: `Bearer ${process.env.ASTRIFY_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ "evento": "pedido_pago", "email": "ana@exemplo.com", "dados": { "pedido": 1234, "valor": 199.9 } }),});console.log(res.status, await res.json());import os, requests
r = requests.post( "https://api2.astrify.com.br/v1/workflows/eventos", headers={"Authorization": f"Bearer {os.environ['ASTRIFY_API_KEY']}"}, json={ "evento": "pedido_pago", "email": "ana@exemplo.com", "dados": { "pedido": 1234, "valor": 199.9, }, }, timeout=20,)print(r.status_code, r.json())Resposta
Status 200, em JSON:
{ "success": true, "disparado": true, "lead_id": "a1d7e5c0-2b93-4f68-8c15-7e4b9d03f2a6"}Erros
| Status | Quando acontece |
|---|---|
401 | Chave ausente, inválida, expirada ou revogada. |
403 | Sem o escopo exigido, cargo sem permissão, IP não autorizado ou registro de outra empresa. |
422 | Corpo ou parâmetro com formato inválido. O detail lista os campos com problema. |
429 | Limite de 120 requisições por minuto da chave. Espere o tempo do cabeçalho Retry-After. |
O formato dos erros e as retentativas estão em Limites de uso e erros.