POST api/DocusignEvent/Sendenvelopeevent
Send to an approval flow any envelope event from Docusign
Request Information
URI Parameters
None.
Body Parameters
DocusignEnvelopeEventDto| Name | Description | Type | Additional information |
|---|---|---|---|
| TimeGenerated | date |
None. |
|
| EnvelopeID | string |
None. |
|
| Subject | string |
None. |
|
| UserName | string |
None. |
|
| Status | string |
None. |
|
| Created | date |
None. |
|
| Deleted | date |
None. |
|
| Sent | date |
None. |
|
| Delivered | date |
None. |
|
| Signed | date |
None. |
|
| Completed | date |
None. |
|
| Declined | date |
None. |
|
| TimedOut | date |
None. |
|
| Docs | Collection of DocumentPDF |
None. |
Request Formats
application/json, text/json
Sample:
{
"timeGenerated": "2026-05-09T14:03:32.2593026+02:00",
"envelopeID": "sample string 2",
"subject": "sample string 3",
"userName": "sample string 4",
"status": "sample string 5",
"created": "2026-05-09T14:03:32.2677635+02:00",
"deleted": "2026-05-09T14:03:32.2677635+02:00",
"sent": "2026-05-09T14:03:32.2677635+02:00",
"delivered": "2026-05-09T14:03:32.2677635+02:00",
"signed": "2026-05-09T14:03:32.2677635+02:00",
"completed": "2026-05-09T14:03:32.2677635+02:00",
"declined": "2026-05-09T14:03:32.2677635+02:00",
"timedOut": "2026-05-09T14:03:32.2677635+02:00",
"docs": [
{
"name": "sample string 1",
"pdfBytes": "QEA=",
"documentId": 2
},
{
"name": "sample string 1",
"pdfBytes": "QEA=",
"documentId": 2
}
]
}
text/html
Sample:
{"timeGenerated":"2026-05-09T14:03:32.2593026+02:00","envelopeID":"sample string 2","subject":"sample string 3","userName":"sample string 4","status":"sample string 5","created":"2026-05-09T14:03:32.2677635+02:00","deleted":"2026-05-09T14:03:32.2677635+02:00","sent":"2026-05-09T14:03:32.2677635+02:00","delivered":"2026-05-09T14:03:32.2677635+02:00","signed":"2026-05-09T14:03:32.2677635+02:00","completed":"2026-05-09T14:03:32.2677635+02:00","declined":"2026-05-09T14:03:32.2677635+02:00","timedOut":"2026-05-09T14:03:32.2677635+02:00","docs":[{"name":"sample string 1","pdfBytes":"QEA=","documentId":2},{"name":"sample string 1","pdfBytes":"QEA=","documentId":2}]}
application/xml, text/xml
Sample:
<DocusignEnvelopeEventDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.ApprovalFlowModule.Application.Dtos.Dtos.DocusignEventAgg">
<Completed>2026-05-09T14:03:32.2677635+02:00</Completed>
<Created>2026-05-09T14:03:32.2677635+02:00</Created>
<Declined>2026-05-09T14:03:32.2677635+02:00</Declined>
<Deleted>2026-05-09T14:03:32.2677635+02:00</Deleted>
<Delivered>2026-05-09T14:03:32.2677635+02:00</Delivered>
<Docs>
<DocumentPDF>
<DocumentId>2</DocumentId>
<Name>sample string 1</Name>
<PDFBytes>QEA=</PDFBytes>
</DocumentPDF>
<DocumentPDF>
<DocumentId>2</DocumentId>
<Name>sample string 1</Name>
<PDFBytes>QEA=</PDFBytes>
</DocumentPDF>
</Docs>
<EnvelopeID>sample string 2</EnvelopeID>
<Sent>2026-05-09T14:03:32.2677635+02:00</Sent>
<Signed>2026-05-09T14:03:32.2677635+02:00</Signed>
<Status>sample string 5</Status>
<Subject>sample string 3</Subject>
<TimeGenerated>2026-05-09T14:03:32.2593026+02:00</TimeGenerated>
<TimedOut>2026-05-09T14:03:32.2677635+02:00</TimedOut>
<UserName>sample string 4</UserName>
</DocusignEnvelopeEventDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiDataResultOfDocusignEnvelopeEventDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | DocusignEnvelopeEventDto |
None. |
|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| Errors | Collection of CustomError |
None. |
|
| Warnings | Collection of string |
None. |
Response Formats
application/json, text/json, text/html
Sample:
Sample not available.