Inicia uma execução de fluxo

post

https://clickflow-runner-sandbox.clicksign.com/api/v1/flows/{flow_id}/execute

Cria uma execução no orquestrador e persiste o estado inicial no Runner. O Authorization desta requisição (access_token) é repassado ao orquestrador, que o introspecciona para identificar a conta dona do flow.

Canal whatsapp (padrão): Runner envia mensagens automáticas via WhatsApp — apresentação, links de form/verify/signature e conclusão. contact.phone_number é obrigatório.

Canal api: Runner não envia mensagens automáticas. A resposta inclui current_step.url com o link do passo atual para o cliente entregar ao contato. contact.phone_number é opcional. Exceção: steps acceptance sempre enviam WhatsApp (interação funcional) e falham se o contato não tiver phone_number.

Canal web: mesmo comportamento de api. A resposta também inclui web_url, o link da execução na experiência web da Clicksign.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

flow_id

string

required

Flow ID

Body Params

Contato, canal, callback_url, context e arquivos

callback_url

string

URL https opcional para receber o webhook de saída do Flow (execution.started, step.started, step.finished, execution.finished). Precisa ser URL absoluta https, com host e sem usuário ou senha na URL. Endereço de loopback, rede privada, link-local (incluindo metadata de nuvem), não especificado ou multicast é recusado. URL inválida retorna 400 sem criar a execução. Sem o campo, nenhum evento é emitido. Cada evento sai uma vez; falha de entrega não interrompe a execução. O corpo traz event_id, event, occurred_at e execution no mesmo formato do GET da execução.

channel

string

enum

Canal de comunicação da execução.
"whatsapp" (padrão, compatível com versões anteriores): Runner envia mensagens automáticas via WhatsApp em todas as etapas — apresentação, steps form/verify/signature e conclusão. contact.phone_number é obrigatório.
"api": Runner não envia mensagens automáticas. O cliente é responsável por entregar os links ao contato. A resposta inclui o objeto current_step com id, type e url do passo em andamento. contact.phone_number é opcional (exceto para steps acceptance, que sempre exigem WhatsApp).
"web": mesmo comportamento de "api", mais o campo web_url na resposta com o link da execução na experiência web da Clicksign.
Omitir o campo equivale a "whatsapp". Qualquer outro valor retorna 400.

Allowed:

contact

object

context

object

Objeto livre injetado no disparo pelo sistema chamador (dados do próprio sistema). Persistido no HEAD da execução e usado na interpolação de envelope/signatários, pré-preenchimento de formulários ({{chave}} em context_map_keys) e variáveis de consent. Na mesma chave, o contact vence este context, e este context vence a resposta de um formulário anterior. Tamanho máximo após JSON: 150 KiB; acima disso retorna 400 sem criar a execução. O body HTTP do POST /execute, incluindo files[], tem teto de 16 MiB; acima disso a execução também não é criada.

files

array of objects

Arquivo(s) enviados em base64 no próprio disparo. Opcional (aditivo) — sem este
campo, o comportamento atual é mantido. Cada item tem content_base_64 (data-URL
completa, ex.: "data:application/pdf;base64,...") e key — o step signature do fluxo
declara documents[].kind "runner_files" com o mesmo key pra casar o conteúdo com o
slot certo (nome do arquivo é definido no fluxo, não aqui).

files

Responses

201Created

400Bad Request

500Internal Server Error