Skip to main content
POST
Invocar um workflow pelo seu entrypoint HTTP

Authorizations

X-API-Key
string
header
required

Path Parameters

entrypoint_key
string
required

Segmento de URL do entrypoint.

Body

application/json

The payload an external client POSTs to /workflow-endpoints/{entrypoint_key}.

Exactly two fields, per the epic: the subject's document and free-form typed metadata. The model forbids unknown fields like every other model here, so a client that invents a third top-level key hears about it instead of having it silently dropped.

document
string
required

CPF ou CNPJ do subject. Aceito formatado ou não; é normalizado e seus dígitos verificadores são checados antes de qualquer outra coisa.

Minimum string length: 1
metadata
Metadata · object

Objeto livre carregado junto com o subject. Campos declarados no metadata_schema do entrypoint são validados por tipo e ficam legíveis pelas condições do workflow; campos não declarados são aceitos e armazenados, mas nenhuma condição os lê. Ver WorkflowEntrypointSummary.metadata_schema para o formato da declaração.

Response

Successful Response

execution_uuid
string<uuid>
required

Identificador público da execução, para consulta.

status
enum<string>
required

Estado no momento da resposta. queued significa aceito e não iniciado, seja porque a conta está no teto de concorrência, seja porque o orquestrador ainda não pegou a execução.

Available options:
queued,
running,
waiting_human,
succeeded,
failed,
cancelled
case_uuid
string<uuid> | null

Identificador público do caso de revisão humana que esta execução abriu, ou nulo quando a execução ainda não chegou a um nó de mesa. Numa chamada deduplicada, é o caso ABERTO da execução que já ocupava a chave de deduplicação (hoje uma execução não-terminal do mesma conta, subject e entrypoint, não mais um caso aberto), não a execução em si: se esse caso já foi decidido, o campo vem nulo aqui mesmo com a execução ainda em andamento, porque a leitura filtra por caso aberto.

deduplicated
boolean
default:false

True quando esta chamada NÃO criou uma execução porque já existe uma aberta para o mesma conta, subject e entrypoint. O identificador retornado é o dessa execução existente.

desk_uuid
string<uuid> | null

Mesa do caso aberto, quando houver um e ele estiver em alguma fila agora. Nulo se não há caso aberto, ou se o caso está aberto mas entre posições, como no meio de uma escalada.

queue_uuid
string<uuid> | null

Fila em que o caso aberto está AGORA, que pode não ser aquela em que entrou: uma escalada move o caso dentro da mesma mesa. Nulo se não há caso aberto, ou se o caso está aberto mas entre posições, como no meio de uma escalada.