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 "Document" resource with the "Create" operation, it simulates creating a new document in the ClickSign system. This is useful when you want to programmatically initiate a document that requires electronic signatures.

Common scenarios include:

  • Automating the creation of documents that need to be signed electronically.
  • Integrating document management into larger automated workflows.
  • Preparing documents for subsequent signing or envelope grouping.

For example, you might use this node to create a contract document named "Service Agreement" before sending it out for signatures.

Properties

Name Meaning
Document Name The name/title of the document to be created. This is a required string input where you specify the document's name.

Output

The output JSON contains information about the created document, structured as follows:

{
  "success": true,
  "message": "Documento criado com sucesso",
  "data": {
    "key": "generated_key",
    "filename": "Name of the document provided in input",
    "status": "open",
    "created_at": "ISO 8601 timestamp of creation"
  }
}
  • success: Indicates if the creation was successful.
  • message: A confirmation message.
  • data: Contains details about the created document:
    • key: A unique identifier for the document (simulated/generated).
    • filename: The document name as provided by the user.
    • status: The current status of the document, here always "open".
    • created_at: Timestamp of when the document was created.

No binary data output is produced by this operation.

Dependencies

  • This node requires access to the ClickSign API for real-world usage, including appropriate API authentication credentials (e.g., an API key or token).
  • In n8n, you must configure the node with valid credentials to interact with the ClickSign service.
  • The bundled code here simulates responses and does not perform actual API calls, so in a production environment, proper API integration would be necessary.

Troubleshooting

  • Unsupported Operation Error: If you select an operation other than "create" for the "document" resource, the node will throw an error indicating the operation is not supported. Ensure you select a valid operation.
  • Missing Required Property: The "Document Name" property is required. Omitting it will likely cause the node to fail or produce invalid output.
  • API Authentication Issues: In a real setup, failure to provide valid API credentials will result in authentication errors.
  • Continue on Fail Behavior: If enabled, the node will continue processing remaining items even if one fails, returning error details in the output JSON.

Links and References

Discussion