👍
Observadores de Assinatura
Com esta funcionalidade, você poderá configurar observadores que acompanhem o processo de assinatura.

📘
Requisição para a criação de Observadores de Assinatura na Clicksign. Esta é uma requisição POST para /api/v3/envelopes/{envelope_id}/signature_watchers. No body, deverão ser enviados os atributos do observador.

POST /api/v3/envelopes/{envelope_id}/signature_watchers HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

Tipo de dados

Atributo	Descrição	Obrigatório
`type`	Determina o tipo de dados, que aqui deve ser `signature_watchers`.	Sim

Atributos para criação do observador

Atributo	Descrição	Obrigatório	Padrão
`email`	Email do observador e onde será notificado.	Sim	Sem valor padrão
`kind`	Define se o observador será notificado em todo o processo ou apenas na conclusão. Os valores possíveis são: `all_steps` ou `on_finished`	Sim	Sem valor padrão
`communicate_events`	Objeto responsável por comunicar eventos ao observador. Para saber mais sobre os atributos desse objeto, acesse a seção Comunicação de eventos.	Não	Sem valor padrão
`attach_documents_enabled`	Determina se o observador deve receber os documentos finalizados.	Não	false

Comunicação de eventos

Em communicate_events podem ser indicados signature_watcher_document_sent, signature_watcher_document_signed, signature_watcher_document_deadline, signature_watcher_document_canceled e signature_watcher_envelope_closed, descritos a seguir:

Atributo	Descrição	Obrigatório	Padrão	Exemplo
`signature_watcher_document_sent`	Indica como a Clicksign deve comunicar ao observador que ele irá acompanhar a assinatura do documento. Campos válidos: `email`.	Não	email	email
`signature_watcher_document_signed`	Indica como a Clicksign deve comunicar ao observador que o documento foi assinado por um dos signatários. Campos válidos: `email`.	Não	email	email
`signature_watcher_document_deadline`	Indica como a Clicksign deve comunicar ao observador que o documento está próximo de atingir a data limite de assinatura. Campos válidos: `email`.	Não	email	email
`signature_watcher_document_canceled`	Indica como a Clicksign deve comunicar ao observador que o documento foi cancelado. Campos válidos: `email`.	Não	email	email
`signature_watcher_envelope_closed`	Indica como a Clicksign deve comunicar ao observador que o documento foi finalizado. Campos válidos: `email`.	Não	email	email

❗️
Se a requisição para a Clicksign falhar
Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo completo

Request

POST api/v3/envelopes/{envelope_id}/signature_watchers HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

{
    "data": {
        "type": "signature_watchers",
        "attributes": {
            "email": "[email protected]",
            "kind": "all_steps",
            "communicate_events": {
              "signature_watcher_document_sent": "email",
              "signature_watcher_document_signed": "email",
              "signature_watcher_document_deadline": "email",
              "signature_watcher_document_canceled": "email",
              "signature_watcher_envelope_closed": "email"
            }
        }
    }
}

Response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json; charset=utf-8

{
  "data": {
    "id": "31ec2704-2695-45ae-8425-5373f5eb4caf",
    "type": "signature_watchers",
    "links": {
      "self": "https://sandbox.clicksign.com/api/v3/envelopes/a4ecaa4a-1453-4e63-95cf-988422f7003f/signature_watchers/31ec2704-2695-45ae-8425-5373f5eb4caf"
    },
    "attributes": {
      "email": "[email protected]",
      "kind": "all_steps",
      "attach_documents_enabled": false,
      "communicate_events": {
        "signature_watcher_document_sent": "email",
        "signature_watcher_document_signed": "email",
        "signature_watcher_document_deadline": "email",
        "signature_watcher_document_canceled": "email",
        "signature_watcher_envelope_closed": "email"
      },
      "created": "2024-05-08T15:43:14.090-03:00",
      "modified": "2024-05-08T15:43:14.090-03:00"
    }
  }
}