ClickFlow: orquestração de jornadas transacionais

O ClickFlow é a esteira de automação da Clicksign: ele orquestra, em uma sequência linear e configurável, os módulos que compõem uma jornada de contratação (Aceite, Formulário, Verificação/KYC, Assinatura), entregando a experiência ao consumidor final via WhatsApp ou API.

A arquitetura é dividida em duas peças com responsabilidades bem separadas:

Cada módulo (ClickForm, Verify/KYC, Assinatura) é uma unidade de execução independente — o Orquestrador só sabe orquestrar steps, não conhece a lógica interna de cada módulo.

O ClickFlow é contratado e habilitado de forma independente da API v3 da Clicksign (Assinatura Eletrônica/Envelopes). Sua empresa ainda não tem o ClickFlow habilitado? Fale com o nosso time comercial.

🔒 Autenticação

Todas as rotas de /api/v1 (Orquestrador e Executor) exigem o header Authorization com o UUID do access_token — sem prefixo Bearer. O token é gerado na página de configurações da API da Clicksign e validado por introspecção. Veja mais detalhes aqui.

🚀 Primeiros passos

1. Criar um flow (draft)

POST /api/v1/flows no Orquestrador. Um flow é uma lista ordenada de steps — cada um com um type (acceptance, form, verify, kyc, signature, consent) e um context específico daquele tipo.

{
  "name": "Proposta Crédito — form",
  "steps": [
    {
      "type": "form",
      "context": {
        "version_key": "sua-form-version-key"
      }
    }
  ]
}

Página de referência: Criar Flow.

2. Publicar o flow

Um flow criado nasce em draft — precisa ser publicado antes de aceitar execuções.

Endpoint: PATCH /api/v1/flows/{id}/publish

Página de referência: Publicar Flow.

3. Iniciar uma execução

Com o flow publicado, dispare uma execução informando o contato — essa chamada é feita no Executor (Runner), não no Orquestrador.

Endpoint: POST /api/v1/flows/{flow_id}/execute

{
  "contact": {
    "person_name": "Maria da Silva",
    "phone_number": "5511999999999"
  }
}

Por padrão (channel omitido ou "whatsapp"), o Executor envia as mensagens e links automaticamente via WhatsApp. Com "channel": "api", o Executor não envia nada — a resposta traz current_step.url, e cabe ao seu sistema entregar esse link ao contato (útil para uma experiência web própria).

Página de referência: Iniciar Execução.

4. Acompanhar a execução

Endpoint: GET /api/v1/executions/{execution_id} (disponível tanto no Orquestrador quanto no Executor — o Executor devolve o estado consolidado, incluindo os arquivos anexados).

Página de referência: Estado da Execução.

5. Ambientes

Para saber mais sobre os ambientes, acesse este tutorial. Abaixo, as URLs a serem utilizadas:

✅ Checklist de sucesso

• Recebi o flow_id ao criar o flow?
• O flow está published antes de tentar executar?
• Escolhi o channel certo para o meu caso (WhatsApp gerenciado vs. entrega própria dos links)?

Próximo passo ➡️

• Orquestrador — todos os tipos de step, ciclo de vida do flow e da execução.
• Executor — canal whatsapp vs. api, upload de arquivos, cancelamento.
• Collections — Postman, Insomnia e Bruno prontos para testar o Orquestrador e o Executor.