Skip to main content
GET
Disparar um webhook (GET)

Autorizações

Authorization
string
header
obrigatório

Token bearer JWT emitido pelo provider de identidade. Envie-o no cabeçalho Authorization como Bearer <token>.

Cabeçalhos

Idempotency-Key
string

Chave de idempotência opcional para evitar execuções duplicadas a partir da mesma entrega de 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).

Resposta

O workflow terminou dentro da janela síncrona. O corpo traz os resultados de negócio finais. Uma rota XML retorna o documento <results> equivalente.

completedAt
string<date-time>

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

Exemplo:

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

executionId
string<uuid>

Identificador único da execução.

Exemplo:

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

finalOutput
object

Saída agregada do último passo ou o resultado final do workflow.

Exemplo:
startedAt
string<date-time>

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

Exemplo:

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

status
string

Status final da execução.

Exemplo:

"completed"

stepResults
object[]

Lista ordenada de resultados para cada passo executado.

workflowId
string<uuid>

ID do workflow que foi executado.

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"