Formalização do documento na jornada

signature e embedded_signature

O que é. Etapa de formalização eletrônica. O motor é o da API da Clicksign. A esteira é pass-through: aceita o que a API de Assinatura define e repassa íntegro. Comportamento de campo de envelope ou de signatário não é decisão de produto do Flow. A fonte é a documentação de Envelope. Existem dois tipos de passo: o clássico (signature) e a assinatura incorporada (embedded_signature).

O que faz. Cria o envelope, convoca os signatários e aguarda a conclusão. Quando a API da Clicksign confirma a assinatura, pelo evento sign, o Executor avança o passo. A experiência de quem assina muda conforme o tipo.

• signature: a pessoa assina no widget padrão da Clicksign, em geral pela webview da jornada (WhatsApp ou canal api), com os requisitos declarados em auths.
• embedded_signature: a pessoa assina no ClickWidget, a tela de assinatura usada somente neste passo. Ela vê o PDF já carimbado e concorda com os termos sem sair da jornada. O link é gerado pela esteira, que também gerencia a sessão.

Como funciona na esteira

O passo declara documentos e as configurações do envelope. A gestão de signatários depende do tipo.

• signature: sem signers[], o único signatário é o contato da execução. Com a lista preenchida, o Executor cria só quem está nela. Testemunha, fiador e segundo titular entram nessa lista. Dá para injetar a identidade com {{chave}}: do contact (o cliente da esteira), do context do disparo ou de um form anterior. Ver Injetar dados no flow.
• embedded_signature: aceita vários documentos e um único signatário, o contato da execução. signers[] não é utilizado nesta versão.

signature aceita signature_watchers[]. Em embedded_signature, observadores ainda não estão disponíveis. Um observador acompanha o envelope: não assina, não autentica e não segura a conclusão. O detalhe dos campos está na criação de observador da API de Assinatura. O canal (whatsapp, api ou web) continua definido no disparo pelo Executor.

Documento. O Flow aceita template, arquivo no S3 (file), arquivo no disparo (runner_files) e anexo coletado em um Form anterior (form_attachment). Neste último caso, field_key aponta para um campo file ou image; o arquivo entra no envelope como documento separado e também é assinado. São aceitos PDF, DOC/DOCX, TXT, PNG e JPG/JPEG pela API. A interface do ClickForm não aceita TXT. O limite é de 20 MB para imagens e 100 MB para os demais formatos. form_attachment não funciona com campo em repetidor/lista nem em embedded_signature; campo opcional sem arquivo é ignorado.

Modelo com de-para explícito. Hoje, se template_mappings não for enviado, uma IA faz o de-para das variáveis do modelo automaticamente. O mapa manual serve para quando a empresa não quer usar IA, por qualquer motivo. Em documento template, ele relaciona cada variável à chave de um Form anterior, do context ou do contato, sem {{ }}. Com o mapa presente, inclusive vazio, a IA não entra. Omitir o campo ou enviar null mantém a IA. Chave sem valor disponível vira string vazia.

Schema no Orquestrador e no Criar Flow. Upload no disparo no Executor e em Iniciar execução. Comportamento de modelo, documento e envelope em Automação com Modelos, Documentos e Envelope.

Configuração. Envelope (settings) e, no signature, signatários extras (signers[]): schema no Orquestrador. Comportamento em Envelope, Campos e regras do envelope e Signatários.

O que a esteira faz diferente da API da Clicksign sozinha

• Só o evento sign avança a jornada. Recusa, vencimento ou cancelamento do envelope ainda não encerram a execução. No embedded_signature, a tela de carregamento espera esse evento para mostrar o sucesso.
• Assinatura presencial (presential) não é suportada. A API da Clicksign devolve erro.
• Cancelar a execução não cancela o envelope na API da Clicksign.
• Rúbrica posicionada não está disponível no Flow.
• Omitir settings.name usa o padrão {nome da esteira} - {contato} - {data/hora}.

Observações exclusivas do embedded_signature

Estas observações valem para a assinatura incorporada, e não para a signature clássica.

• Não é preciso enviar auths. Se o campo vier no passo, ele é ignorado. A autenticação enviada à API da Clicksign é sempre embedded_signature.
• A Clicksign não envia WhatsApp nem e-mail com o link deste passo. Quem distribui o link é a esteira.
• O envelope não aparece na área de pendências do signatário nem na assinatura em massa. A única tela para assinar é o ClickWidget, exclusiva deste passo.
• signature_watchers[] ainda não está disponível.
• Ainda não está disponível no canal web. Em breve, passa a funcionar nesse canal.

Próximo passo ➡️

• Módulos — volte ao mapa da jornada.
• Orquestrador — schema do passo.
• Executor — disparo, canal e upload de arquivo.
• FAQ: dúvidas em ClickFlow — respostas curtas para as dúvidas mais comuns.