ClickSign icon

ClickSign

Integração com a API do ClickSign para assinatura eletrônica

Actions3

Overview

This node integrates with the ClickSign API to manage electronic signature workflows. Specifically, for the Signer - Create operation, it allows users to create a new signer by providing their email and full name. This is useful in scenarios where you need to programmatically add signers to documents or envelopes for electronic signing processes.

Practical examples include:

  • Automatically adding a signer when a new contract document is generated.
  • Creating signers as part of an automated approval workflow.
  • Managing signers dynamically based on external triggers or data sources.

Properties

Name Meaning
Signer Email Email address of the signer
Signer Name Full name of the signer

Output

The output JSON contains information about the created signer:

{
  "success": true,
  "message": "Signatário criado com sucesso",
  "data": {
    "key": "generated_signer_key",
    "email": "signer@example.com",
    "name": "Full Name of Signer",
    "action": "sign",
    "authentication": "email",
    "status": "waiting",
    "created_at": "2024-06-xxTxx:xx:xx.xxxZ"
  }
}
  • key: Unique identifier for the signer.
  • email: The signer's email address.
  • name: The signer's full name.
  • action: The action assigned to the signer (e.g., "sign").
  • authentication: Method used to authenticate the signer (here, "email").
  • status: Current status of the signer (initially "waiting").
  • created_at: Timestamp of creation in ISO format.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the ClickSign API.
  • Needs appropriate API authentication credentials configured in n8n (such as an API key or token).
  • The node depends on n8n's internal error handling and parameter retrieval mechanisms.

Troubleshooting

  • Common issues:

    • Missing required properties (signerEmail or signerName) will cause errors.
    • Invalid email formats might not be accepted by the API.
    • Network or authentication failures when connecting to ClickSign API.

  • Error messages:

    • "Operação não suportada: <operation>" indicates an unsupported operation was requested; ensure only supported operations are used.
    • Errors related to missing parameters will typically indicate which input is required.
    • If the node throws an error but Continue On Fail is enabled, the error message will be returned in the output JSON under the error field.

To resolve errors:

  • Verify all required inputs are provided and correctly formatted.
  • Check API credentials and network connectivity.
  • Use the node’s built-in error messages to identify unsupported operations or missing parameters.

Links and References

Discussion