Skip to navigation

Embedded Callback Event Codes

View as Markdown

This page describes functionality for the older eSignature SOAP API. See Envelopes: listStatusChanges for more information on this topic in the more actively-supported eSignature REST API documentation.

When Docusign redirects the Recipient to the Embedded client application, it will append a URL parameter “event” to the CallbackURL to indicate which terminal state the Recipient reached. The valid values are: | Event | Description | | --- | --- | | OnSigningComplete | The Recipient successfully completed the signing the document. | | OnViewingComplete | The Recipient successfully viewed the document. | | OnCancel | The Recipient canceled the document while viewing the envelope. | | OnDecline | The recipient declined the envelope. | | OnSessionTimeout | The recipient session has timed out. | | OnTTLExpired | If a Recipient Token URL is invoked after it is expired. | | OnAccessCodeFailed | The Recipient failed to provide the correct Access Code. | | OnIdCheckFailed | The Recipient failed to pass the ID Check authentication questions. | | OnException | If an exception is thrown. | | OnFaxPending | If a faxed in document is pending. |

Asynchronous Document Generation

The following value can be set to cause the system to report that the envelope has been completed before the actual final documents have been generated. | Name | Schema Type | Description | | --- | --- | --- | | GenerateSignedDocumentAsynch | Boolean | Optional flag. If true, the final document generation will happen after the envelope status has been set to ‘Completed’. Default is false. |