Watchers and CC Recipients

How to Add Watchers to Documents Without Assigning Them a Signing Role

Watchers

watchers are people who can follow a document’s progress without performing a signing, approval, or acknowledgment action.

When added as a watcher, the user gains access to the document directly from their document list. They can view its contents and track its progress without being included in the list of signers.

Note: If a signer is also added as a watcher using the same email address, they will continue to participate normally in the signing process but will not receive emails intended for watchers. The API prevents these duplicate notifications automatically.

This feature is available exclusively to users on the Professional plan.

Adding Watchers During Document Creation

When creating a document, the watchers field is part of the DocumentInput object and accepts a list of email addresses:

input DocumentInput {
  watchers: [String!]
}

Example mutation:

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

Variables:

{
  "document": {
    "name": "Service Agreement",
    "watchers": [
      "[e-mail]",
      "[e-mail]"
    ]
  },
  "signers": [
    {
      "email": "[e-mail]",
      "action": "SIGN"
    }
  ]
}

Because document creation also uploads the document file, the request must use the multipart/form-data format, as explained on the Creating a Document page.

Notifying Watchers

When configs.notify_watchers is enabled, watchers can also receive emails about signing events performed by the document’s signers.

input DocumentConfigInput {
  notify_watchers: Boolean = false
}

The default value is false. Set it to true to enable these notifications:

{
  "document": {
    "name": "Service Agreement",
    "watchers": [
      "[e-mail]"
    ],
    "configs": {
      "notify_watchers": true
    }
  }
}

Updating Watchers

This feature is also available through the updateDocument mutation. In this case, watchers is part of the UpdateDocumentInput object.

Example:

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

Variables:

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

CC Recipients

The cc field allows you to specify people who should receive a copy of the document after the signing process is completed. Unlike signers, CC recipients do not need to perform any action. They also do not receive intermediate updates like watchers do.

This feature is available when creating or updating a document:

cc: [EmailInput]

Each address must be provided as an object containing an email field:

{
  "document": {
    "name": "Service Agreement",
    "cc": [
      {
        "email": "[e-mail]"
      },
      {
        "email": "[e-mail]"
      }
    ]
  }
}