Skip to main content
Existing Functionality

Roll up recipient status to the envelope summary level

Categories:Developer Experience
  • February 6, 2025
  • 3 replies
  • 39 views

Scott.Nieman
Troubleshooter
Forum|alt.badge.img+4

The DocuSign User Interface in the Agreements view is able to show whether an email has a Delivery Failure.  This is under the Sent status / category.  However, since there is a delivery failure that recipient has not received the envelope, therefore the envelope is really NOT sent in the business sense.  Today, the business thinks that everything OK when it is clearly NOT OK.   And we do NOT want to rely on a report. 

The DocuSign Connect callback JSON shows the happy envelopeSummary.status =

"envelopeSummary": {
"status": "sent",

This does not follow the traditional ‘lookout below’ pattern, where at the highest level the payload indicates there is a problem with the envelope, and if you want more details, you must dig deeper into the payload.  

And yes!  There is detail below.  In the JSON Connect payload it states there is a problem inside one of the recipients.signers object: 

"status": "autoresponded",
 "autoRespondedReason": "smtp; 550 5.4.1 Recipient address rejected: Access denied.\n [LN2PEPF000100CD.GBRP265.PROD.OUTLOOK.COM 2025-02-05T11:17:05.398Z\n 08DD3E4205AB062F]",

The DocuSign platform knows how to catch this issue and has mapped this as Delivery Failure in the UI layer.  

Therefore, the envelopeSummary.status IDEALLY would be mapped to ‘Delivery Failure’ or a more general ‘Error’ status, and our code would catch this, and then navigate to the next level down to the recipients.signers[*].status to test each recipient’s status.  Plus, we have to test every type of recipient.  Ouch.

We general do NOT like to look at the lowest level first as that is not performant.  I am sure the DocuSign UI would like this too.
 

3 replies

Scott.Nieman
Troubleshooter
Forum|alt.badge.img+4
  • Author
  • Troubleshooter
  • February 6, 2025

To be safe for now, we will check for both 4yx and 5yz permanent statuses (RFC 821) or 5.y.x format (RFC 3463).  I noticed both formats are being returned in the string.  

 "autoRespondedReason": "smtp; 550 5.4.1 Recipient address rejected: Access denied.\n [LN2PEPF000100CD.GBRP265.PROD.OUTLOOK.COM 2025-02-05T11:17:05.398Z\n 08DD3E4205AB062F]",

It sure would be nice if these smtp status codes were separated into their own properties.

“smtpRFC821StatusCode”: “550”,

“smtpRFC3463StatusCode”: “5.4.1”


Raileen.Del
Docusign Employee
Forum|alt.badge.img+3
  • Docusign Employee
  • February 27, 2026

Thanks so much for your idea, ​@Scott.Nieman. I think this request can be accomplished using Docusign Connect. In your Connect configuration, register for recipient events rather than, or in addition to, envelope events. Your integration can listen for “recipient-autoresponded” (sent when an email delivery has failed) events and compute a rolled-up recipient status at the envelope level.

Docusign Connect overview: https://developers.docusign.com/platform/webhooks/connect/

Connect event triggers: https://developers.docusign.com/platform/webhooks/connect/event-triggers/


Raileen.Del
Docusign Employee
Forum|alt.badge.img+3
  • Docusign Employee
  • February 27, 2026
Idea SubmittedExisting Functionality