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 Envelope resource with the Create operation, it allows users to create a new envelope that can contain multiple documents for signing. This is useful in scenarios where you need to send a batch of documents together for electronic signatures, such as contracts, agreements, or forms that require multiple signatories.

Practical example: A legal team wants to send a set of contract documents bundled into one envelope to several clients for signature. Using this node, they can programmatically create an envelope named accordingly, which will then be used to add documents and signers before sending out for signature.

Properties

Name Meaning
Envelope Name The name of the envelope to be created. This identifies the envelope within the ClickSign system.

Output

The output JSON object for the Envelope Create operation has the following structure:

{
  "success": true,
  "message": "Envelope criado com sucesso",
  "data": {
    "key": "generated_envelope_key",
    "name": "Name of the envelope provided in input",
    "status": "draft",
    "created_at": "ISO 8601 timestamp string"
  }
}
  • success: Indicates if the creation was successful.
  • message: A confirmation message in Portuguese ("Envelope created successfully").
  • data: Contains details about the newly created envelope:
    • key: A unique identifier for the envelope (simulated/generated).
    • name: The envelope name as provided by the user.
    • status: The current status of the envelope, initially set to "draft".
    • created_at: Timestamp of when the envelope was created.

No binary data output is produced by this operation.

Dependencies

  • Requires access to the ClickSign API for electronic signature management.
  • Needs an API authentication token or API key credential configured in n8n to authorize requests to ClickSign.
  • The node expects proper configuration of credentials within n8n to interact with the ClickSign service.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials may cause authentication failures.
    • Providing an empty or missing envelope name will likely result in an error since the property is required.
    • Network connectivity problems can prevent communication with the ClickSign API.

  • Error messages:

    • "Operação não suportada: <operation>" — This means the requested operation is not supported by the node for the selected resource. Ensure you select a valid operation.
    • Errors related to missing parameters will typically indicate which required field is absent.

  • Resolution tips:

    • Verify that the API key or authentication token is correctly set up in n8n credentials.
    • Ensure all required fields, especially "Envelope Name," are filled.
    • Check network connectivity and API endpoint accessibility.

Links and References

Discussion