Clicksign

Electronic signature and document management platform.

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions

This connector provides 39 actions:

Action	Purpose	Parameters
post_api_v3_envelopes	Criar Envelope	data: { . data (object) } (object) required
post_api_v3_envelopes_by_envelope_id_documents	Criar Documento	envelope_id (string) required data: { . data (object) } (object) required
get_api_v3_envelopes_by_envelope_id_documents	Listar Documentos	envelope_id (string) required
post_api_v3_envelopes_by_envelope_id_signers	Criar Signatário	envelope_id (string) required data: { . data (object) } (object) required
post_api_v3_envelopes_by_envelope_id_requirements	Adicionar Requisitos qualificação	envelope_id (string) required data: { . data (object) } (object) required
patch_api_v3_envelopes_by_envelope_id	Atualizar Envelope	envelope_id (string) required data: { . data (object) } (object) required
post_api_v3_envelopes_by_envelope_id_notifications	Notificar Envelope	envelope_id (string) required data: { . data (object) } (object) required
post_api_v3_templates	Criar Modelo	data: { . data (object) } (object) required
get_api_v3_envelopes_by_envelope_id_documents_by_document_id_events	Eventos de um Documento	envelope_id (string) required document_id (string) required
get_api_v3_envelopes_by_envelope_id_events	Eventos dos Documentos de um Envelope	envelope_id (string) required
get_api_v3_envelopes_by_envelope_id_signature_watchers	Listar Observadores do Envelope	envelope_id (string) required
post_api_v3_envelopes_by_envelope_id_signature_watchers	Criar Observador da Assinatura	envelope_id (string) required data: { . data (object) } (object) required
get_api_v3_envelopes_by_envelope_id_signature_watchers_by_signature_watcher_id	Detalhes do Observador	envelope_id (string) required signature_watcher_id (string) required
delete_api_v3_envelopes_by_envelope_id_signature_watchers_by_signature_watcher_id	Excluir Observador	envelope_id (string) required signature_watcher_id (string) required
post_api_v3_folders	Criar Pasta	data: { . data (object) } (object) required
post_api_v3_envelopes_by_envelope_id_bulk_requirements	Adicionar Requisitos autenticação Copy	envelope_id (string) required data: { . atomic:operations (array) } (object) required
get_api_v3_envelopes_by_envelope_id_requirements	Conferir requisitos do envelope	envelope_id (string) required
get_api_v3_users	Listar Usuários	No parameters
post_api_v3_users	Criar Usuário	data: { . data (object) } (object) required
get_api_v3_users_by_user_id	Detalhes do Usuário	user_id (string) required
get_api_v3_memberships	Listar Membros	No parameters
post_api_v3_memberships	Criar Membro	data: { . data (object) } (object) required
patch_api_v3_memberships_by_membership_id	Editar Membro	membership_id (string) required data: { . data (object) } (object) required
delete_api_v3_memberships_by_membership_id	Deletar Membro	membership_id (string) required
get_api_v3_envelopes_by_envelope_id	Detalhes do Envelope	envelope_id (string) required
delete_api_v3_envelopes_by_envelope_id_documents_by_document_id	Excluir Documento	envelope_id (string) required document_id (string) required
get_api_v3_envelopes_by_envelope_id_signers	Listar Signatários	envelope_id (string) required
post_api_v3_envelopes_by_envelope_id_signers_by_signer_id_notifications	Notificar um Signatário	envelope_id (string) required signer_id (string) required data: { . data (object) } (object) required
get_api_v3_templates	Listar Modelos	No parameters
get_api_v3_templates_by_template_id	Detalhes do Modelo	template_id (string) required
get_api_v3_folders	Listar Pastas	No parameters
get_api_v3_folders_by_folder_id	Detalhes de uma Pasta	folder_id (string) required
post_api_v3_webhooks	Criar Webhook	data (object) required
get_api_v3_webhooks	Listar Webhooks	No parameters
get_api_v3_webhooks_by_webhook_id	Detalhes do Webhook	webhook_id (string) required
patch_api_v3_webhooks_by_webhook_id	Editar Webhook	webhook_id (string) required data (object) required
delete_api_v3_webhooks_by_webhook_id	Excluir Webhook	webhook_id (string) required
post_api_v3_acceptance_term_whatsapps	Criar Aceite via WhatsApp	data: { . data (object) } (object) required
post_api_v3_auto_signature_terms	Criar termo de assinatura automática	data: { . data (object) } (object) required

Webhook Events

This connector emits 30 events back to your workflow via the connection's webhook callback. Subscribe to them by attaching a workflow trigger to the connection.

Event	Description
upload	Ocorre quando é realizado o upload de um documento.
add_image	Ocorre quando é adicionada uma imagem ao documento.
close	Ocorre quando um documento é finalizado manualmente.
auto_close	Ocorre quando um documento é finalizado automaticamente após a última assinatura.
deadline	Ocorre quando a data limite de assinatura é atingida.
document_closed	Ocorre quando um documento é finalizado e está pronto para download.
cancel	Ocorre quando um documento é cancelado manualmente.
add_signer	Ocorre quando são adicionados signatários a um documento.
remove_signer	Ocorre quando são removidos signatários de um documento.
sign	Ocorre quando um signatário assina um documento.
signature_started	Ocorre quando o fluxo de assinatura é iniciado por um signatário.
refusal	Ocorre quando um documento é recusado.
attempts_by_whatsapp_exceeded	Ocorre quando as tentativas de reenvio de token via WhatsApp são excedidas.
attempts_by_liveness_or_facematch_exceeded	Ocorre quando as tentativas de autenticação via selfie dinâmica ou biometria facial são excedidas.
liveness_refused	Ocorre quando a análise da prova de vida é recusada.
facematch_refused	Ocorre quando a análise da biometria facial é recusada.
biometric_refused	Ocorre quando a análise da biometria facial SERPRO é recusada.
documentscopy_refused	Ocorre quando a análise de documentoscopia é recusada.
ocr_refused	Ocorre quando a análise de OCR é recusada.
update_deadline	Ocorre quando a data limite de assinatura de um documento é alterada.
update_auto_close	Ocorre quando a opção de finalização automática de um documento é alterada.
update_locale	Ocorre quando o idioma de um documento é alterado.
custom	Ocorre em fluxos de eventos customizados por exemplo, envio de token por e-mail ou SMS.
acceptance_term_enqueued	Aceite via WhatsApp enfileirado para envio.
acceptance_term_sent	Aceite via WhatsApp enviado ao destinatário.
acceptance_term_completed	Aceite via WhatsApp concluído com sucesso.
acceptance_term_refused	Aceite via WhatsApp recusado pelo destinatário.
acceptance_term_canceled	Aceite via WhatsApp cancelado.
acceptance_term_expired	Aceite via WhatsApp expirado.
acceptance_term_error	Erro no processamento do aceite via WhatsApp.