API atual/Referência completa/Fluxos operacionais

Execuções de um fluxo

Lista as execuções de um fluxo e os passos de cada execução, para ver o que aconteceu e por que falhou.

Cada vez que o evento do gatilho acontece com o fluxo ativo, a plataforma cria uma execução (run), uma por evento e por fluxo (o mesmo evento nunca cria duas). A execução percorre o desenho: avalia condições e executa ações, gravando um passo para cada etapa. Leitura exige view_ops_flows ou manage_ops_flows.

Listar execuções

GET/api/v1/admin/ops-flows/{id}/runsAdmin

Listar execuções de um fluxo

Parâmetros de caminho

iduuidobrigatório

Id do fluxo (UUID).

Parâmetros de consulta

statusstring

activedonefailed

Filtra pelo resultado.

Exemplo de requisição (execuções)

bash

curl "$BASE_URL/api/v1/admin/ops-flows/7f89112b-4bef-46fb-ac55-4e66baf978c4/runs?status=failed" \
  -H "Authorization: Bearer $TOKEN"

Resposta (execuções)

200Execuções

json

{
  "runs": [
    {
      "id": "9a1c0f64-2f3b-4f0e-a1a8-6b2c0d9e7a10",
      "flow_id": "7f89112b-4bef-46fb-ac55-4e66baf978c4",
      "event_id": "order.created:6af86ed3-d949-474d-8e04-513c6e83bfe4",
      "entity_type": "order",
      "entity_id": "6af86ed3-d949-474d-8e04-513c6e83bfe4",
      "status": "done",
      "current_node": "",
      "context": { "order.total": 5266, "order.item_count": 1, "order.payment_method": "pix" },
      "created_at": "2026-10-11T21:25:10Z"
    }
  ],
  "total": 1
}

Campos da resposta

runsarray

Execuções, da mais nova para a mais antiga.

runs[].iduuid

Id da execução.

runs[].flow_iduuid

O fluxo.

runs[].event_idstring

Identifica o evento que originou a execução (tipo:id).

runs[].entity_typestring

order, product, return ou user.

runs[].entity_idstring

Id da entidade que disparou.

runs[].statusstring

activedonefailed

active em andamento, done concluída, failed falhou.

runs[].current_nodestring

Etapa atual, quando em andamento.

runs[].contextobject

Os dados do evento que as condições usam (veja os campos por gatilho em Gatilhos e ações).

runs[].errorstring

Motivo da falha, quando failed.

runs[].created_atstring

Quando começou.

totalinteger

Quantidade.

Erros (execuções)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `view_ops_flows` nem `manage_ops_flows`.	`{"error":"insufficient privileges","privilege_required_any":["view_ops_flows","manage_ops_flows"]}`
500	Falha ao consultar ou gravar.	`{"error":"failed","detail":"..."}`

Passos de uma execução

GET/api/v1/admin/ops-flows/runs/{runId}/stepsAdmin

Passos de uma execução

Parâmetros de caminho

runIduuidobrigatório

Id da execução.

Exemplo de requisição (passos)

bash

curl "$BASE_URL/api/v1/admin/ops-flows/runs/9a1c0f64-2f3b-4f0e-a1a8-6b2c0d9e7a10/steps" \
  -H "Authorization: Bearer $TOKEN"

Resposta (passos)

200Passos

json

{
  "steps": [
    { "id": "1c0e5a52-0000-4000-8000-000000000001", "run_id": "9a1c0f64-2f3b-4f0e-a1a8-6b2c0d9e7a10", "node_id": "n_cond", "kind": "condition", "result": { "branch": "no" }, "created_at": "2026-10-11T21:25:10Z" }
  ],
  "total": 1
}

Campos da resposta

stepsarray

Um passo por etapa executada.

steps[].node_idstring

Etapa do desenho.

steps[].kindstring

conditionaction

condition ou action.

steps[].resultobject

Resultado: { "branch": "yes" } em condição, ou o retorno da ação.

steps[].errorstring

Erro da etapa, quando falhou.

steps[].created_atstring

Quando rodou.

totalinteger

Quantidade.

Erros (passos)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `view_ops_flows` nem `manage_ops_flows`.	`{"error":"insufficient privileges","privilege_required_any":["view_ops_flows","manage_ops_flows"]}`
500	Falha ao consultar ou gravar.	`{"error":"failed","detail":"..."}`

Veja também

Execuções de um fluxo

Lista as execuções de um fluxo e os passos de cada execução, para ver o que aconteceu e por que falhou.

Listar execuções

GET/api/v1/admin/ops-flows/{id}/runsAdmin

Listar execuções de um fluxo

Parâmetros de caminho

iduuidobrigatório

Id do fluxo (UUID).

Parâmetros de consulta

statusstring

activedonefailed

Filtra pelo resultado.

Exemplo de requisição (execuções)

bash

curl "$BASE_URL/api/v1/admin/ops-flows/7f89112b-4bef-46fb-ac55-4e66baf978c4/runs?status=failed" \
  -H "Authorization: Bearer $TOKEN"

Resposta (execuções)

200Execuções

json

{
  "runs": [
    {
      "id": "9a1c0f64-2f3b-4f0e-a1a8-6b2c0d9e7a10",
      "flow_id": "7f89112b-4bef-46fb-ac55-4e66baf978c4",
      "event_id": "order.created:6af86ed3-d949-474d-8e04-513c6e83bfe4",
      "entity_type": "order",
      "entity_id": "6af86ed3-d949-474d-8e04-513c6e83bfe4",
      "status": "done",
      "current_node": "",
      "context": { "order.total": 5266, "order.item_count": 1, "order.payment_method": "pix" },
      "created_at": "2026-10-11T21:25:10Z"
    }
  ],
  "total": 1
}

Campos da resposta

runsarray

Execuções, da mais nova para a mais antiga.

runs[].iduuid

Id da execução.

runs[].flow_iduuid

O fluxo.

runs[].event_idstring

Identifica o evento que originou a execução (tipo:id).

runs[].entity_typestring

order, product, return ou user.

runs[].entity_idstring

Id da entidade que disparou.

runs[].statusstring

activedonefailed

active em andamento, done concluída, failed falhou.

runs[].current_nodestring

Etapa atual, quando em andamento.

runs[].contextobject

Os dados do evento que as condições usam (veja os campos por gatilho em Gatilhos e ações).

runs[].errorstring

Motivo da falha, quando failed.

runs[].created_atstring

Quando começou.

totalinteger

Quantidade.

Erros (execuções)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `view_ops_flows` nem `manage_ops_flows`.	`{"error":"insufficient privileges","privilege_required_any":["view_ops_flows","manage_ops_flows"]}`
500	Falha ao consultar ou gravar.	`{"error":"failed","detail":"..."}`

Passos de uma execução

GET/api/v1/admin/ops-flows/runs/{runId}/stepsAdmin

Passos de uma execução

Parâmetros de caminho

runIduuidobrigatório

Id da execução.

Exemplo de requisição (passos)

bash

curl "$BASE_URL/api/v1/admin/ops-flows/runs/9a1c0f64-2f3b-4f0e-a1a8-6b2c0d9e7a10/steps" \
  -H "Authorization: Bearer $TOKEN"

Resposta (passos)

200Passos

json

{
  "steps": [
    { "id": "1c0e5a52-0000-4000-8000-000000000001", "run_id": "9a1c0f64-2f3b-4f0e-a1a8-6b2c0d9e7a10", "node_id": "n_cond", "kind": "condition", "result": { "branch": "no" }, "created_at": "2026-10-11T21:25:10Z" }
  ],
  "total": 1
}

Campos da resposta

stepsarray

Um passo por etapa executada.

steps[].node_idstring

Etapa do desenho.

steps[].kindstring

conditionaction

condition ou action.

steps[].resultobject

Resultado: { "branch": "yes" } em condição, ou o retorno da ação.

steps[].errorstring

Erro da etapa, quando falhou.

steps[].created_atstring

Quando rodou.

totalinteger

Quantidade.

Erros (passos)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `view_ops_flows` nem `manage_ops_flows`.	`{"error":"insufficient privileges","privilege_required_any":["view_ops_flows","manage_ops_flows"]}`
500	Falha ao consultar ou gravar.	`{"error":"failed","detail":"..."}`