Docusign add voidedReason to callback XML?

2
votes

I'm using the Docusign REST Api and in the create envelope request I am requesting event notifications for "voided" see below. The callback occurs, but the voidedReason is not present in the XML, so to fetch voidedReason I have to make a separate API call to get the status of the envelope as suggested in: DocuSign - getting void envelope reason.

Is there some reason (no pun intended) that voidedReason is not included in the webhook callback XML for docusignenvelopeinformation.envelopestatus? It seems inconsistent in tha declinereason is provided in the receipientstatuses.recipientstatus object. Would be nice to not have to make the additional API call. 

  eventNotification: {
      url: docusignCallbackUrl,
      loggingEnabled: "true",
      includeDocumentFields: "true",
      requireAcknowledgment: "true", 
      envelopeEvents: [
        {envelopeEventStatusCode: "completed"},
        {envelopeEventStatusCode: "declined"},
        {envelopeEventStatusCode: "voided"},
      ],
      recipientEvents: [
        {recipientEventStatusCode: "Completed"},
      ],
    }
2
apicallbackdocusignapi

2 Answers

1
votes

The DocuSign connect configuration offers a way to "Include Envelope Voided Reason" in the DocuSign connect XML payload/notification. This was added In October 2016 timeframe.

0
votes

Add:

includeEnvelopeVoidReason: "true"

to your eventNotification.