Base URL

https://lip-backend-1064145932505.southamerica-east1.run.app

Endpoints

GET /api/external/flows
GET /api/external/flows/{id}
POST /api/external/flows/{id}/trigger

Escopos:

flows:read — listar e obter flows
flows:trigger — disparar um flow

Listar flows

GETBuscar/api/external/flows

Busca os flows do workspace.

Escopo: flows:readSincrono — responde 200 com os dados

Query params:

page (number, default 1)
limit (number, default 20)
status (string): DRAFT, ACTIVE, ARCHIVED

Exemplo:

Resposta:

Obter flow

GETBuscar/api/external/flows/{id}

Busca um flow pelo id, com contagem de nos e tipo de gatilho.

Escopo: flows:readSincrono — responde 200 com os dados

Resposta:

Disparar flow

POSTDisparar/api/external/flows/{id}/trigger

Dispara a execucao de um flow para um numero de WhatsApp.

Escopo: flows:triggerAssincrono — responde 202 com requestId

Por ser um disparo, e assincrono: responde 202 com requestId. Acompanhe em /usage/status/{requestId}.

Body

tostringobrigatorio

Numero de WhatsApp do destinatario (DDI 55).

userMessagestringopcional

Mensagem inicial que entra no contexto do flow.

variablesobjectopcional

Variaveis injetadas na execucao do flow.

O flow precisa estar ACTIVE

Apenas flows com status ACTIVE podem ser disparados; caso contrario a API retorna 400. O numero passa pela mesma validacao de WhatsApp das demais rotas.

Exemplo:

Resposta (202 Accepted):

Erros comuns

400 to ausente, numero invalido ou flow nao esta ACTIVE
401 API key invalida
403 escopo insuficiente
404 flow nao encontrado