Função observador e CCs

Como adicionar observadores a documentos, sem que precisem ter função de assinatura

Observadores

Os watchers são pessoas que podem acompanhar um documento sem precisar exercer uma função de assinatura, aprovação ou reconhecimento.

Ao ser adicionado como observador, o usuário passa a ter acesso ao documento diretamente em sua listagem de documentos. Dessa forma, ele pode consultar o conteúdo e acompanhar seu andamento sem precisar fazer parte da lista de signatários.

Caso um signatário também seja adicionado como observador usando o mesmo endereço de e-mail, ele continuará participando normalmente da assinatura, mas não receberá os e-mails destinados aos observadores. Internamente, a API evita o envio dessas notificações duplicadas.

Este recurso está disponível exclusivamente para usuários do plano Profissional.

Adicionando observadores na criação

Na criação, o campo watchers faz parte do objeto DocumentInput e recebe uma lista de endereços de e-mail:

input DocumentInput {
  watchers: [String!]
}

Exemplo de mutation:

mutation CreateDocument(
  $document: DocumentInput!
  $signers: [SignerInput!]!
  $file: Upload!
) {
  createDocument(
    document: $document
    signers: $signers
    file: $file
  ) {
    id
    name
    watchers {
      email
    }
  }
}

Trecho das variáveis:

{
  "document": {
    "name": "Contrato de prestação de serviços",
    "watchers": [
      "[e-mail]",
      "[e-mail]"
    ]
  },
  "signers": [
    {
      "email": "[e-mail]",
      "action": "SIGN"
    }
  ]
}

Como a criação também envia o arquivo do documento, a requisição precisa seguir o formato multipart/form-data, conforme explicado na página Criando um Documento.

Notificando os observadores

Quando configs.notify_watchers estiver habilitado, os observadores também poderão receber e-mails sobre os eventos de assinatura realizados pelos signatários do documento.

input DocumentConfigInput {
  notify_watchers: Boolean = false
}

Como o valor padrão é false, envie true quando quiser habilitar essas notificações:

{
  "document": {
    "name": "Contrato de prestação de serviços",
    "watchers": [
      "[e-mail]"
    ],
    "configs": {
      "notify_watchers": true
    }
  }
}

Atualizando os watchers

O recurso também está disponível na mutation updateDocument. Nesse caso, watchers faz parte do objeto UpdateDocumentInput.

Exemplo:

mutation UpdateDocument(
  $documentId: UUID!
  $document: UpdateDocumentInput!
) {
  updateDocument(
    id: $documentId
    document: $document
  ) {
    id
    name
    watchers {
      email
      user_id
      organization_id
      group_id
      folder_id
    }
  }
}

Variáveis:

{
  "documentId": "UUID_DO_DOCUMENTO",
  "document": {
    "watchers": [
      "[e-mail]",
      "[e-mail]"
    ],
    "configs": {
      "notify_watchers": true
    }
  }
}

Cópias de e-mail

O campo cc permite definir pessoas que devem receber uma cópia do documento após a conclusão do processo de assinatura. Diferentemente dos signatários, elas não precisam realizar nenhuma ação. Também não acompanham as atualizações intermediárias como os observadores.

O recurso está disponível tanto na criação quanto na atualização do documento:

cc: [EmailInput]

Cada endereço deve ser enviado dentro de um objeto com o campo email:

{
  "document": {
    "name": "Contrato de prestação de serviços",
    "cc": [
      {
        "email": "[e-mail]"
      },
      {
        "email": "[e-mail]"
      }
    ]
  }
}