get-document-status
Updated Nov 4, 2026·3 min read
Shows where a document stands after generate-document or send-for-signing: whether it is saved and where, fresh links to it, and its signers' progress. Each call returns the current state without waiting, so the agent decides how often to check.
The user the connection acts as needs a CloudFiles Document Generation license. See Who the Agent Acts As.
| Input | Required | Description |
|---|
documentId | Yes | The documentId that generate-document returned. |
Document status fields
get-document-status returns these fields. Fields without a value are left out of the result.
| Field | Description |
|---|
documentId | The document's ID, used with get-document-status and send-for-signing. |
status | generating, ready or failed. See Status values below. |
recordId | The Salesforce record the document was filled from. |
fileName | The document's file name. |
savedFileId | The saved file's ID in its library. On a Salesforce record, the ContentDocument ID. |
savedLibrary | Where the document was saved: salesforce for the record's Salesforce Files, otherwise the folder's library. |
savedDriveId | The drive the document was saved in, for libraries with drives. |
previewUrl | Opens the document in the CloudFiles viewer. Stops working after a few minutes. |
downloadUrl | Downloads the document. The link expires after a short time. |
error | Why the document or its signing failed, written to be passed on to the user as it is. |
signingStatus | How signing stands, once the document is generated. See Status values below. |
signers | Who the template sends the document to, in signing order, with the signer fields below. |
signedPreviewUrl | Opens the signed copy once signing is completed. Stops working after a few minutes. |
signedDownloadUrl | Downloads the signed copy once signing is completed. The link expires after a short time. |
Signer fields
| Field | Description |
|---|
name | The signer's name. |
email | The signer's email address. |
order | Signing order. Recipients with the same order receive the document together. |
role | signer signs the document, and copy receives the signed copy. |
status | Where this signer stands. See Signer status below. |
changedAt | When the status last changed, in ISO 8601 format. |
declineReason | Why the signer declined, when they did. |
Status values
Document status
| Value | Meaning |
|---|
generating | The document is not saved yet. Check again with get-document-status. |
ready | The document is saved where savedLibrary says. |
failed | The document could not be generated. error says why. |
Signing status
| Value | Meaning |
|---|
none | The template names no signers. |
pending | The document is about to be held for approval or sent. |
waiting | Held until send-for-signing is called or someone clicks Approve on the record page. |
sending | Being sent through DocuSign. |
sent | Sent to the signers. |
completed | Every signer has signed. |
declined | A signer declined to sign. |
voided | The signing request was voided. |
failed | The signing request could not be sent. |
Signer status
| Value | Meaning |
|---|
not_sent | Not sent to this signer yet. |
sent | Sent to this signer. |
opened | The signer opened the document. |
signed | The signer signed. |
declined | The signer declined to sign. |
auto_replied | DocuSign received an automatic reply from the signer's email address, such as an out-of-office message. |
Example requests
| You ask | What the agent does |
|---|
| Is the quote ready? | Calls get-document-status and, once the status is ready, shares the preview and download links. |
| Send me a fresh link to the proposal. | Calls get-document-status again, which returns new preview and download links. |
| Has the customer signed yet? Who is still outstanding? | Calls get-document-status and reports the signing status and each signer's progress. |