I just wanted to ask if the Webhook response json changed?

Question

I have noticed right off the recipientId used to be in the data but now seems to be in the recipients object? Also has the event statuses changed any, seems that there were different statuses before?

Old
{
   "event": "",
   "apiVersion": "v2.1",
   "uri": "",
   "retryCount": 0,
   "configurationId": ,
   "generatedDateTime": "",
   "data": {
       "accountId": "",
       "userId": "",
       "envelopeId": "",
       "recipientId": "1",
       "envelopeSummary": {}
       }
}

New

{
   "event": "",
   "apiVersion": "",
   "uri": "",
   "retryCount": 0,
   "configurationId": ,
   "generatedDateTime": "",
   "data": {
       "accountId": "",
       "userId": "",
       "envelopeId": "",
       "envelopeSummary": {}
       }
}

Iandro.Simoes · Answer

Hi ​@cweeksYour old payload likely represented a recipient event, while the new payload represents an envelope event or a configuration that now includes recipient details only in the envelope summary.In JSON SIM Connect, arecipient-level event such as recipient-completed includes data.recipientId.An envelope-level event such as envelope-completed does not include a single data.recipientId, because the event applies to the whole envelope.If you request recipient data with includeData: ["recipients"], recipient IDs appear inside data.envelopeSummary.recipients.signers[].See the JSON SIM format in the documentation below.https://developers.docusign.com/platform/webhooks/connect/json-sim-event-model/Best regards,

Sign up

You can login or register as either a Docusign customer or developer. If you don’t already have a Docusign customer or developer account, you can create one for free when registering.

Docusign Community

You can login or register as either a Docusign customer or developer. If you don’t already have a Docusign customer or developer account, you can create one for free when registering.