Envelope callbacks
This document contains the endpoint reference for creating and managing envelope callbacks.
Create callback
POST
/api/v1/envelope/callback/add
Headers:
Authorization
Yes
Bearer authorization token
Content-Type
Yes
Use application/json
Mailbox
Yes
Mailbox context header with the current mailbox UUID
Request body:
{
"url": "string",
"retries": 3,
"timeout": 5000,
"successCode": 200,
"login": "string",
"password": "string",
"filter": {
"label": [
"string"
],
"status": [
"DRAFT"
],
"subject": "string",
"createDateFrom": "2026-07-21T15:58:42.779Z",
"createDateTo": "2026-07-21T15:58:42.779Z",
"receiveDateFrom": "2026-07-21T15:58:42.779Z",
"receiveDateTo": "2026-07-21T15:58:42.779Z",
"expireDateFrom": "2026-07-21T15:58:42.779Z",
"expireDateTo": "2026-07-21T15:58:42.779Z",
"sendDateFrom": "2026-07-21T15:58:42.779Z",
"sendDateTo": "2026-07-21T15:58:42.779Z",
"template": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"templateVersion": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"sender": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"form": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"metadata": {
"externalId": "CRM-1024"
}
}
}Request body fields:
url
string
Callback URL
retries
integer
Number of callback retry attempts, default: 3, maximum: 10
timeout
integer
Request timeout in milliseconds, default: 5000
successCode
integer
HTTP response code that DocStudio treats as successful, default: 200
login
string
Login for Basic authentication, when the callback URL requires it
password
string
Password for Basic authentication, when the callback URL requires it
filter
object
Envelope filter that defines which envelopes trigger the callback
The request body is required. The Swagger schema does not mark individual body fields as required.
Filter fields
Use the filter object to limit when the callback is sent. For envelope form callbacks, use the form array and pass one or more form UUIDs. If the callback must trigger only for completed envelopes created from a specific form, combine form with status: ["COMPLETED"].
label
array of strings
Label UUID or name
status
array of strings
Envelope status; supported values: DRAFT, SENT, WAITING, COMPLETED, CANCELLED, EXPIRED, ON_APPROVAL
subject
string
Envelope subject
createDateFrom
date-time
Creation date from
createDateTo
date-time
Creation date to
receiveDateFrom
date-time
Receive date from
receiveDateTo
date-time
Receive date to
expireDateFrom
date-time
Expiration date from
expireDateTo
date-time
Expiration date to
sendDateFrom
date-time
Envelope sending date from
sendDateTo
date-time
Envelope sending date to
template
array of UUIDs
Template IDs
templateVersion
array of UUIDs
Template version IDs
sender
array of UUIDs
Sender mailbox IDs
form
array of UUIDs
Form IDs, used to target envelopes created from selected forms
metadata
object
Metadata key-value pairs used as callback filter criteria
Create callback for a form
Use this structure when the callback must be sent only for envelopes created from a specific envelope form. Replace {formUuid} with the actual form UUID and set the required target status for your integration.
This callback matches envelopes created from the selected form with the COMPLETED status.
Create callback response
The endpoint returns 201 Created with the created callback configuration. Save the returned id; it is the callback UUID used by callback management endpoints.
Response fields:
url
string
Callback URL
retries
integer
Number of retry attempts
timeout
integer
Request timeout in milliseconds
successCode
integer
HTTP response code treated as successful
id
UUID
Envelope callback ID
authType
string
Authentication type; supported values: NONE, BASIC
filter
object
Envelope filter used by the callback
Status codes
201
Callback created successfully
List callbacks
GET
/api/v1/envelope/callback/list
Headers:
Authorization
Yes
Bearer authorization token
Mailbox
Yes
Mailbox context header with the current mailbox UUID
The response is an array of callback objects in the create callback response format.
Status codes
200
Callbacks returned successfully
Callback payload example
GET
/api/v1/envelope/callback/callbackRequestPayload
Response:
Payload fields:
uuid
UUID
Envelope UUID
status
string
Envelope status
subject
string
Envelope subject
label
array of UUIDs
Envelope labels
receiveDate
date-time
Envelope receive date
expireDate
date-time
Envelope expiration date
template
UUID
Template UUID
sender
UUID
Sender mailbox UUID
mailbox
UUID
Current mailbox UUID
Status codes
200
Callback payload example returned
Make sure the envelope matches the callback filter. Return the configured successCode before the configured timeout.
Related topics
Last updated
Was this helpful?