POST api/DocuSignConnectWebhookFunctionV2

Request Information

URI Parameters

None.

Body Parameters

WebhookDocusignModelV2
NameDescriptionTypeAdditional information
event

string

None.

apiVersion

string

None.

uri

string

None.

retryCount

integer

None.

configurationId

integer

None.

generatedDateTime

date

None.

data

DataV2

None.

Request Formats

application/json, text/json

Sample:
{
  "event": "sample string 1",
  "apiVersion": "sample string 2",
  "uri": "sample string 3",
  "retryCount": 4,
  "configurationId": 5,
  "generatedDateTime": "2025-12-21T20:39:05.0756586+00:00",
  "data": {
    "accountId": "sample string 1",
    "userId": "sample string 2",
    "envelopeId": "sample string 3",
    "envelopeSummary": {
      "status": "sample string 1",
      "documentsUri": "sample string 2",
      "recipientsUri": "sample string 3",
      "attachmentsUri": "sample string 4",
      "envelopeUri": "sample string 5",
      "emailSubject": "sample string 6",
      "emailBlurb": "sample string 7",
      "envelopeId": "sample string 8",
      "signingLocation": "sample string 9",
      "customFieldsUri": "sample string 10",
      "notificationUri": "sample string 11",
      "enableWetSign": "sample string 12",
      "allowMarkup": "sample string 13",
      "allowReassign": "sample string 14",
      "createdDateTime": "2025-12-21T20:39:05.0756586+00:00",
      "lastModifiedDateTime": "2025-12-21T20:39:05.0756586+00:00",
      "deliveredDateTime": "2025-12-21T20:39:05.0756586+00:00",
      "initialSentDateTime": "2025-12-21T20:39:05.0756586+00:00",
      "sentDateTime": "2025-12-21T20:39:05.0756586+00:00",
      "completedDateTime": "2025-12-21T20:39:05.0756586+00:00",
      "statusChangedDateTime": "2025-12-21T20:39:05.0756586+00:00",
      "documentsCombinedUri": "sample string 22",
      "certificateUri": "sample string 23",
      "templatesUri": "sample string 24",
      "brandId": "sample string 25",
      "expireEnabled": "sample string 26",
      "expireDateTime": "2025-12-21T20:39:05.0756586+00:00",
      "expireAfter": "sample string 28",
      "sender": {
        "userName": "sample string 1",
        "userId": "sample string 2",
        "accountId": "sample string 3",
        "email": "sample string 4",
        "ipAddress": "sample string 5"
      },
      "customFields": {
        "textCustomFields": [
          {
            "fieldId": "sample string 1",
            "name": "sample string 2",
            "show": "sample string 3",
            "required": "sample string 4",
            "value": "sample string 5"
          },
          {
            "fieldId": "sample string 1",
            "name": "sample string 2",
            "show": "sample string 3",
            "required": "sample string 4",
            "value": "sample string 5"
          }
        ],
        "listCustomFields": [
          {},
          {}
        ]
      },
      "envelopeDocuments": [
        {
          "documentId": "sample string 1",
          "documentIdGuid": "sample string 2",
          "name": "sample string 3",
          "type": "sample string 4",
          "uri": "sample string 5",
          "order": "sample string 6",
          "pages": [
            {
              "pageId": "sample string 1",
              "sequence": "sample string 2",
              "height": "sample string 3",
              "width": "sample string 4",
              "dpi": "sample string 5"
            },
            {
              "pageId": "sample string 1",
              "sequence": "sample string 2",
              "height": "sample string 3",
              "width": "sample string 4",
              "dpi": "sample string 5"
            }
          ],
          "display": "sample string 7",
          "includeInDownload": "sample string 8",
          "signerMustAcknowledge": "sample string 9",
          "templateRequired": "sample string 10",
          "authoritativeCopy": "sample string 11",
          "PDFBytes": "sample string 12"
        },
        {
          "documentId": "sample string 1",
          "documentIdGuid": "sample string 2",
          "name": "sample string 3",
          "type": "sample string 4",
          "uri": "sample string 5",
          "order": "sample string 6",
          "pages": [
            {
              "pageId": "sample string 1",
              "sequence": "sample string 2",
              "height": "sample string 3",
              "width": "sample string 4",
              "dpi": "sample string 5"
            },
            {
              "pageId": "sample string 1",
              "sequence": "sample string 2",
              "height": "sample string 3",
              "width": "sample string 4",
              "dpi": "sample string 5"
            }
          ],
          "display": "sample string 7",
          "includeInDownload": "sample string 8",
          "signerMustAcknowledge": "sample string 9",
          "templateRequired": "sample string 10",
          "authoritativeCopy": "sample string 11",
          "PDFBytes": "sample string 12"
        }
      ],
      "envelopeAttachments": [
        {
          "attachmentId": "sample string 1",
          "label": "sample string 2",
          "attachmentType": "sample string 3",
          "accessControl": "sample string 4"
        },
        {
          "attachmentId": "sample string 1",
          "label": "sample string 2",
          "attachmentType": "sample string 3",
          "accessControl": "sample string 4"
        }
      ],
      "purgeState": "sample string 29",
      "envelopeIdStamping": "sample string 30",
      "is21CFRPart11": "sample string 31",
      "signerCanSignOnMobile": "sample string 32",
      "autoNavigation": "sample string 33",
      "isSignatureProviderEnvelope": "sample string 34",
      "hasFormDataChanged": "sample string 35",
      "allowViewHistory": "sample string 36",
      "disableResponsiveDocument": "sample string 37",
      "envelopeMetadata": {
        "allowAdvancedCorrect": "sample string 1",
        "enableSignWithNotary": "sample string 2",
        "allowCorrect": "sample string 3"
      },
      "anySigner": {},
      "envelopeLocation": "sample string 39",
      "isDynamicEnvelope": "sample string 40",
      "burnDefaultTabData": "sample string 41"
    }
  }
}

application/xml, text/xml

Sample:
<WebhookDocusignModelV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASDocuSignD365.Model">
  <apiVersion>sample string 2</apiVersion>
  <configurationId>5</configurationId>
  <data>
    <accountId>sample string 1</accountId>
    <envelopeId>sample string 3</envelopeId>
    <envelopeSummary>
      <allowMarkup>sample string 13</allowMarkup>
      <allowReassign>sample string 14</allowReassign>
      <allowViewHistory>sample string 36</allowViewHistory>
      <anySigner />
      <attachmentsUri>sample string 4</attachmentsUri>
      <autoNavigation>sample string 33</autoNavigation>
      <brandId>sample string 25</brandId>
      <burnDefaultTabData>sample string 41</burnDefaultTabData>
      <certificateUri>sample string 23</certificateUri>
      <completedDateTime>2025-12-21T20:39:05.0756586+00:00</completedDateTime>
      <createdDateTime>2025-12-21T20:39:05.0756586+00:00</createdDateTime>
      <customFields>
        <listCustomFields xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </listCustomFields>
        <textCustomFields>
          <TextCustomFieldV2>
            <fieldId>sample string 1</fieldId>
            <name>sample string 2</name>
            <required>sample string 4</required>
            <show>sample string 3</show>
            <value>sample string 5</value>
          </TextCustomFieldV2>
          <TextCustomFieldV2>
            <fieldId>sample string 1</fieldId>
            <name>sample string 2</name>
            <required>sample string 4</required>
            <show>sample string 3</show>
            <value>sample string 5</value>
          </TextCustomFieldV2>
        </textCustomFields>
      </customFields>
      <customFieldsUri>sample string 10</customFieldsUri>
      <deliveredDateTime>2025-12-21T20:39:05.0756586+00:00</deliveredDateTime>
      <disableResponsiveDocument>sample string 37</disableResponsiveDocument>
      <documentsCombinedUri>sample string 22</documentsCombinedUri>
      <documentsUri>sample string 2</documentsUri>
      <emailBlurb>sample string 7</emailBlurb>
      <emailSubject>sample string 6</emailSubject>
      <enableWetSign>sample string 12</enableWetSign>
      <envelopeAttachments>
        <EnvelopeAttachmentV2>
          <accessControl>sample string 4</accessControl>
          <attachmentId>sample string 1</attachmentId>
          <attachmentType>sample string 3</attachmentType>
          <label>sample string 2</label>
        </EnvelopeAttachmentV2>
        <EnvelopeAttachmentV2>
          <accessControl>sample string 4</accessControl>
          <attachmentId>sample string 1</attachmentId>
          <attachmentType>sample string 3</attachmentType>
          <label>sample string 2</label>
        </EnvelopeAttachmentV2>
      </envelopeAttachments>
      <envelopeDocuments>
        <EnvelopeDocumentV2>
          <PDFBytes>sample string 12</PDFBytes>
          <authoritativeCopy>sample string 11</authoritativeCopy>
          <display>sample string 7</display>
          <documentId>sample string 1</documentId>
          <documentIdGuid>sample string 2</documentIdGuid>
          <includeInDownload>sample string 8</includeInDownload>
          <name>sample string 3</name>
          <order>sample string 6</order>
          <pages>
            <PageV2>
              <dpi>sample string 5</dpi>
              <height>sample string 3</height>
              <pageId>sample string 1</pageId>
              <sequence>sample string 2</sequence>
              <width>sample string 4</width>
            </PageV2>
            <PageV2>
              <dpi>sample string 5</dpi>
              <height>sample string 3</height>
              <pageId>sample string 1</pageId>
              <sequence>sample string 2</sequence>
              <width>sample string 4</width>
            </PageV2>
          </pages>
          <signerMustAcknowledge>sample string 9</signerMustAcknowledge>
          <templateRequired>sample string 10</templateRequired>
          <type>sample string 4</type>
          <uri>sample string 5</uri>
        </EnvelopeDocumentV2>
        <EnvelopeDocumentV2>
          <PDFBytes>sample string 12</PDFBytes>
          <authoritativeCopy>sample string 11</authoritativeCopy>
          <display>sample string 7</display>
          <documentId>sample string 1</documentId>
          <documentIdGuid>sample string 2</documentIdGuid>
          <includeInDownload>sample string 8</includeInDownload>
          <name>sample string 3</name>
          <order>sample string 6</order>
          <pages>
            <PageV2>
              <dpi>sample string 5</dpi>
              <height>sample string 3</height>
              <pageId>sample string 1</pageId>
              <sequence>sample string 2</sequence>
              <width>sample string 4</width>
            </PageV2>
            <PageV2>
              <dpi>sample string 5</dpi>
              <height>sample string 3</height>
              <pageId>sample string 1</pageId>
              <sequence>sample string 2</sequence>
              <width>sample string 4</width>
            </PageV2>
          </pages>
          <signerMustAcknowledge>sample string 9</signerMustAcknowledge>
          <templateRequired>sample string 10</templateRequired>
          <type>sample string 4</type>
          <uri>sample string 5</uri>
        </EnvelopeDocumentV2>
      </envelopeDocuments>
      <envelopeId>sample string 8</envelopeId>
      <envelopeIdStamping>sample string 30</envelopeIdStamping>
      <envelopeLocation>sample string 39</envelopeLocation>
      <envelopeMetadata>
        <allowAdvancedCorrect>sample string 1</allowAdvancedCorrect>
        <allowCorrect>sample string 3</allowCorrect>
        <enableSignWithNotary>sample string 2</enableSignWithNotary>
      </envelopeMetadata>
      <envelopeUri>sample string 5</envelopeUri>
      <expireAfter>sample string 28</expireAfter>
      <expireDateTime>2025-12-21T20:39:05.0756586+00:00</expireDateTime>
      <expireEnabled>sample string 26</expireEnabled>
      <hasFormDataChanged>sample string 35</hasFormDataChanged>
      <initialSentDateTime>2025-12-21T20:39:05.0756586+00:00</initialSentDateTime>
      <is21CFRPart11>sample string 31</is21CFRPart11>
      <isDynamicEnvelope>sample string 40</isDynamicEnvelope>
      <isSignatureProviderEnvelope>sample string 34</isSignatureProviderEnvelope>
      <lastModifiedDateTime>2025-12-21T20:39:05.0756586+00:00</lastModifiedDateTime>
      <notificationUri>sample string 11</notificationUri>
      <purgeState>sample string 29</purgeState>
      <recipientsUri>sample string 3</recipientsUri>
      <sender>
        <accountId>sample string 3</accountId>
        <email>sample string 4</email>
        <ipAddress>sample string 5</ipAddress>
        <userId>sample string 2</userId>
        <userName>sample string 1</userName>
      </sender>
      <sentDateTime>2025-12-21T20:39:05.0756586+00:00</sentDateTime>
      <signerCanSignOnMobile>sample string 32</signerCanSignOnMobile>
      <signingLocation>sample string 9</signingLocation>
      <status>sample string 1</status>
      <statusChangedDateTime>2025-12-21T20:39:05.0756586+00:00</statusChangedDateTime>
      <templatesUri>sample string 24</templatesUri>
    </envelopeSummary>
    <userId>sample string 2</userId>
  </data>
  <event>sample string 1</event>
  <generatedDateTime>2025-12-21T20:39:05.0756586+00:00</generatedDateTime>
  <retryCount>4</retryCount>
  <uri>sample string 3</uri>
</WebhookDocusignModelV2>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.