Get a quick quote with our pricing calculator

Knowledge Base

Browse our knowledge base articles to quickly solve your issue.

New to Workbooks? Use these guides to get started.

Find out more
Back to Knowledge Base
Knowledgebase articles

Monitoring Integration Errors

Last updated : 03/10/2019

When a document is signed using the integration, the signed document is stored in Workbooks by default. If you have configured any field mappings, at the point of signature, the submitted values from the document are also stored back in Workbooks. From time to time, a problem with the integration may result in the form not writing back to Workbooks. If this happens, the integration will write a record to API Data giving details of the issue as follows:

  • Record Id of the source record
  • Record type of the source record
  • Task Id (if using multi-send mode)
  • API Endpoint of the record that failed to update
  • Record Id that failed to update
  • The error that occurred when trying to update the record

Using the “DocuSign Retry Failures” Scheduled Process, the integration will try again periodically to sync the signed document. However, a failed document will continue to fail until the underlying cause of the issue has been resolved. To help identify when there has been an issue, you can build a report on these records. If anything appears on the report, then there has been an issue with the integration.

NOTE: Workbooks Support does not actively monitor your DocuSign integration. If you are unable to resolve the issue, please contact us via support@workbooks.com with details of the issue stored in API Data.
We have created a Report Template which can be saved to your Workbooks database. Click Start > New > Report > Create a report from a template report. Add a filter to find the report called “TEMPLATE – DocuSign Integration – Error Monitor”. Save a copy to your database. You may wish to pin the report to your desktop so you see it when you login, or setup a Scheduled Report Email to periodically review the integration errors. A scheduled email can be configured to only send if there are rows on the report using the “Send if empty” setting. See here for more information.
Previous Article Production vs Sandbox Next Article Sales Tax Rulesets