Integrations Clicksign

Exemplo de Configuração

{
  "action": "use_integration",
  "integration": 2,
  "integration_data": {
    "action": "uploadAndSign",
    "document_field": "123",
    "document_title": "api",
    "signers_field": "113",
    "signer_map": {
      "name": "field_name",
      "email": "field_email",
      "role": "field_action",
      "auth": "field_auth",
      "rubric": "",
      "group": ""
    }
  }
}

action (string)

Define o tipo de ação que a tarefa executa.

Para tarefas de integração, o valor deve ser:

use_integration

Isso indica que a tarefa irá executar uma integração configurada no sistema.

integration (number)

ID da integração cadastrada no seu workspace que será utilizada pela tarefa.

Esse identificador referencia uma integração previamente configurada.

Exemplo:

2

integration_data (object)

Objeto que contém as configurações específicas da integração que será executada.

A estrutura pode variar dependendo da integração utilizada.

integration_data.action (string)

Define qual operação será executada dentro da integração.

Exemplo:

"uploadAndSign"

Nesse caso, a integração realizará o envio de um documento e iniciará um processo de assinatura.

integration_data.document_field (string)

ID do campo do formulário que contém o documento que será enviado para a integração.

Durante a execução da tarefa, o sistema buscará o documento armazenado nesse campo.

Exemplo:

"123"

integration_data.document_title (string)

Título que será atribuído ao documento dentro da plataforma de integração.

Exemplo:

"api"

integration_data.signers_field (string)

ID do campo do formulário que contém os dados dos signatários.

Esse campo geralmente contém uma estrutura com as informações das pessoas que irão assinar o documento.

Exemplo:

"113"

integration_data.signer_map (object)

Define o mapeamento entre o campo escolhido e os dados exigidos pela integração para cada signatário.

Cada propriedade representa um atributo esperado pela integração.

signer_map.name

Campo que contém o nome do signatário.

Exemplo:

"name": "nome"

signer_map.email

Campo que contém o e-mail do signatário.

Exemplo:

"email": "email"

signer_map.role

Campo que define a função ou ação do signatário no processo de assinatura.

Exemplo:

"role": "acao"

signer_map.auth

Campo que define o método de autenticação do signatário.

Exemplo:

"auth": "autenticacao"

signer_map.rubric

Campo opcional que indica se o signatário deve rubricar o documento.

Pode ser deixado vazio caso não seja utilizado.

Exemplo:

"rubric": ""

signer_map.group

Campo opcional utilizado para agrupar signatários ou definir ordem de assinatura.

Exemplo:

"group": ""

Tutorial Integrations

Integrations Clicksign#

Exemplo de Configuração#

action (string)#

integration (number)#

integration_data (object)#

integration_data.action (string)#

integration_data.document_field (string)#

integration_data.document_title (string)#

integration_data.signers_field (string)#

integration_data.signer_map (object)#

signer_map.name#

signer_map.email#

signer_map.role#

signer_map.auth#

signer_map.rubric#

signer_map.group#

Integrations Clicksign

Exemplo de Configuração

action (string)

integration (number)

integration_data (object)

integration_data.action (string)

integration_data.document_field (string)

integration_data.document_title (string)

integration_data.signers_field (string)

integration_data.signer_map (object)

signer_map.name

signer_map.email

signer_map.role

signer_map.auth

signer_map.rubric

signer_map.group