Pular para o conteúdo principal
PUT
/
v1
/
webhooks
/
{path}
Disparar um webhook (PUT)
curl --request PUT \
  --url https://flowker.sandbox.lerian.net/v1/webhooks/{path} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'
{
  "executionId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
  "startedAt": "2026-03-17T14:35:00Z",
  "status": "running",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Autorizações

​
X-API-Key
string
header
obrigatório

Chave de API para autenticar as requisições à API do Flowker. Provisionada por meio da variável de ambiente API_KEY durante o deployment.

Cabeçalhos

​
Idempotency-Key
string

Chave de idempotência opcional para evitar execuções duplicadas a partir da mesma entrega de webhook.

​
X-Webhook-Token
string

Token de verificação por webhook. Validado pelo handler quando configurado na rota do webhook.

Parâmetros de caminho

​
path
string
obrigatório

Caminho do webhook registrado por um workflow. Suporta caminhos aninhados com múltiplos segmentos em tempo de execução. Barras dentro do caminho devem ser codificadas como %2F conforme RFC 3986/OpenAPI 3.1 (por exemplo, use orders%2Fpaid para orders/paid).

Corpo

application/json

Payload do webhook. Tamanho máximo de 1 MB.

Payload do webhook proveniente do sistema externo. O Flowker injeta metadados do webhook (chave _webhook com método, caminho, headers, parâmetros de query e IP remoto) antes de passá-lo ao workflow.

Resposta

Execução do workflow concluída de forma síncrona (estado terminal).

​
executionId
string<uuid>

Identificador único da execução.

Exemplo:

"f7e6d5c4-b3a2-1098-7654-321fedcba098"

​
startedAt
string<date-time>

Marca temporal de quando a execução foi iniciada.

Exemplo:

"2026-03-17T14:35:00Z"

​
status
string

Status inicial da execução (sempre pending).

Exemplo:

"running"

​
workflowId
string<uuid>

ID do workflow sendo executado.

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"