Nó Clicksign

O nó Clicksign do workflow é um cliente REST flexível para a API v1 da Clicksign — plataforma brasileira de assinatura eletrônica. Use-o para criar documentos, cadastrar signatários, vinculá-los a contratos e acompanhar status de assinatura diretamente de Automações.

ID do nó no editor: clicksign_request
URL padrão: GET https://sandbox.clicksign.com/api/v1/documents
Executor: http_request (mesmo motor do nó HTTP genérico)

O que faz

• Envia requisições HTTP autenticadas para a API v1 da Clicksign
• Suporta GET, POST, PUT, PATCH e DELETE
• Retorna status HTTP, data da resposta e headers
• Auth padrão: Access-Token: {{clicksign_access_token}}
• Inclui presets de operação no diálogo de configuração para ações comuns de documento e signatário

Use este nó quando sua empresa já usa Clicksign e você quer automatizar envio de contrato após venda, mudança de estágio no CRM ou envio de formulário — sem montar requisições HTTP brutas do zero.

Pré-requisitos

1. Conta Clicksign (sandbox ou produção)
2. Access Token em Clicksign → Configurações → API (ou equivalente no sandbox)
3. Chave de integração clicksign_access_token em Configurações → Chaves de API
4. Contrato PDF pronto em Base64 (content_base64) ou hospedado em URL que você busca em um passo anterior

Sandbox vs produção: Os templates padrão usam https://sandbox.clicksign.com. Para assinaturas reais, altere todas as URLs para https://app.clicksign.com e use Access Token de produção.

Como configurar

Passo 1 — Definir credenciais

1. Copie seu Access Token da Clicksign
2. Em Configurações → Chaves de API, adicione:
   • Nome: clicksign_access_token
   • Valor: seu Access Token da Clicksign
3. Salve

O template padrão de cabeçalhos envia:

{
  "Content-Type": "application/json",
  "Accept": "application/json",
  "Access-Token": "{{clicksign_access_token}}"
}

Nunca cole o token diretamente nos campos do nó no canvas — use sempre chaves de integração ou variáveis do workflow.

Passo 2 — Adicionar o nó

1. Abra Automações e edite seu workflow
2. Na paleta, abra a categoria Contratos
3. Arraste Clicksign para o canvas
4. Conecte após o trigger ou nós de preparação de dados

Passo 3 — Escolher um preset de operação (recomendado)

Dê duplo clique no nó. O diálogo de configuração lista presets de operação que pré-preenchem URL, método, cabeçalhos e corpo:

Selecione um preset, ajuste os campos e substitua placeholders por variáveis do workflow.

Passo 4 — Configurar campos da requisição

Todos os campos aceitam variáveis do workflow ({{contact.email}}, {{variables.document_key}}, etc.).

Passo 5 — Fluxo típico de assinatura em vários passos

A Clicksign costuma exigir várias chamadas de API encadeadas em um workflow:

1. Criar documento — enviar PDF em Base64
2. Criar signatário — cadastrar o cliente
3. Vincular signatário ao documento — ligar signatário ao documento
4. Finalizar documento (opcional) — travar documento e iniciar processo de assinatura
5. Enviar WhatsApp — notificar cliente com instruções ou link da resposta

Salve IDs de cada passo com nós Variável ou referencie campos aninhados da saída nos nós seguintes.

Detalhes das operações

Criar documento (POST /documents)

URL: https://sandbox.clicksign.com/api/v1/documents
Template de corpo:

{
  "document": {
    "path": "/contrato-{{variables.order_id}}.pdf",
    "content_base64": "{{variables.pdf_base64}}",
    "deadline_at": "{{variables.signature_deadline}}"
  }
}

Dica: Gere Base64 em um nó JavaScript anterior ou busque URL de PDF com nó HTTP e codifique.

Resposta: Salve document.key (chave do documento) para passos seguintes — ex.: {{clicksign_1.data.document.key}}.

Criar signatário (POST /signers)

Template de corpo:

{
  "signer": {
    "name": "{{contact.name}}",
    "email": "{{contact.email}}",
    "documentation": "{{variables.customer_cpf}}",
    "birthday": "{{variables.customer_birthday}}",
    "phone_number": "{{contact.phone}}",
    "auths": ["email"]
  }
}

Resposta: Salve signer.key — ex.: {{clicksign_2.data.signer.key}}.

Vincular signatário ao documento (POST /lists)

Template de corpo:

{
  "list": {
    "document_key": "{{variables.document_key}}",
    "signer_key": "{{variables.signer_key}}",
    "sign_as": "sign"
  }
}

Finalizar documento (PATCH /documents/{key}/finish)

Chame após vincular todos os signatários. Fecha o documento e dispara notificações de assinatura conforme sua configuração na Clicksign.

Buscar documento (GET /documents/{key})

Consulte status do documento. Inspecione data.document.status nos logs de execução para ramificar com nó Condição (ex.: signed, pending, closed).

Saídas do nó

Referencie campos aninhados nos nós seguintes (caminhos exatos dependem do endpoint):

Chave do documento: {{clicksign_1.data.document.key}}
Chave do signatário: {{clicksign_2.data.signer.key}}

Substitua clicksign_1 pelo ID do nó no canvas.

Confirmação de assinatura (webhooks)

O nó Clicksign chama a API; não escuta eventos de assinatura. Para reagir quando um documento for assinado:

1. Crie um segundo workflow com trigger Webhook
2. Em Clicksign → Configurações → Webhooks, registre a URL do webhook da WhatsWave
3. Inscreva-se em eventos como document_signed ou sign (conforme docs de webhooks da Clicksign)
4. No workflow de confirmação, envie agradecimento no WhatsApp, atualize CRM ou dispare fulfillment

Veja Webhooks recebidos para padrões de configuração.

Dicas e boas práticas

• Sempre teste no sandbox (sandbox.clicksign.com) antes de mudar para app.clicksign.com
• Encadeie nós com clareza — um nó Clicksign por chamada de API; use nós Variável para passar document_key e signer_key
• Armazene chaves de documento Clicksign em campos customizados do card no CRM para reconciliação
• Use valores de path significativos (ex.: /contrato-{order_id}.pdf) para facilitar suporte
• Defina deadline_at para evitar documentos sem assinatura por muito tempo
• Combine com nó PDF (Ferramentas) para gerar PDFs de contrato antes de codificar em Base64
• Combine com Enviar mensagem (WhatsWave) para entregar links de assinatura no WhatsApp
• Inspecione Histórico de execução ao depurar — a Clicksign retorna erros de validação detalhados em data

Exemplos de uso

Enviar contrato após card do CRM ir para "Proposta aceita"

1. Webhook ou trigger CRM WhatsWave quando o card entra na coluna
2. JavaScript — monta PDF em Base64 a partir de variáveis do template
3. Clicksign — criar documento
4. Variável — salva document_key
5. Clicksign — criar signatário a partir dos campos do contato
6. Variável — salva signer_key
7. Clicksign — vincular signatário ao documento
8. Clicksign — finalizar documento
9. Enviar WhatsApp — "Seu contrato está pronto para assinar. Confira seu e-mail: {{contact.email}}"

Verificar status de assinatura em agenda

1. Trigger Schedule diário
2. Variável — carrega lista de document_key pendentes do CRM ou banco
3. Loop sobre as chaves
4. Clicksign GET — busca status do documento
5. Condição — se assinado, move card no CRM e notifica vendedor

Fluxo de contrato assistido por Agente

1. Agente de IA qualifica lead e coleta CPF + e-mail
2. Nós Variável armazenam dados do cliente
3. Cadeia Clicksign — documento + signatário + list + finish
4. Enviar mensagem com instruções de assinatura

FAQ

Por que o nó retorna 401 Unauthorized?
O Access Token está ausente, expirado ou não se chama clicksign_access_token. Verifique a chave em Configurações → Chaves de API e se a URL corresponde ao ambiente do token (sandbox vs produção).

Por que 422 Unprocessable Entity ao criar documento?
Causas comuns: Base64 inválido, content_base64 vazio, deadline_at malformado ou PDF acima do limite de tamanho. Verifique data na execução para mensagens de erro da Clicksign.

Posso enviar PDF de URL em vez de Base64?
Este template do nó usa content_base64. Busque o PDF em nó HTTP anterior, codifique em Base64 em JavaScript e passe para a Clicksign.

Qual a diferença entre este nó e o nó HTTP?
Funcionalmente o mesmo executor (http_request), mas Clicksign vem pré-configurado com cabeçalhos de auth, URL sandbox padrão, presets de operação e agrupamento na paleta Contratos.

Preciso chamar "finalizar documento"?
Depende do fluxo da sua conta Clicksign. Muitos fluxos exigem finalizar o documento após vincular signatários antes de enviar notificações.

Como envio o link de assinatura no WhatsApp?
A Clicksign costuma e-mail/SMS aos signatários conforme auths. Para entrega no WhatsApp, extraia a URL de assinatura da resposta da API (após list/finish) ou configure notificações na Clicksign; depois inclua o link em nó Enviar mensagem.

Um documento pode ter vários signatários?
Sim. Repita criar signatário + vincular signatário para cada parte e finalize uma vez quando todos estiverem vinculados.

Referência da API

Resumo dos endpoints dos presets

Artigos relacionados

• Visão geral de Contratos
• Nó Zapsign
• Nó HTTP
• Variáveis no workflow
• Webhooks recebidos
• Nó PDF — gerar PDFs de contrato antes do upload