Envelope Callbacks Overview

Configure envelope callbacks to receive notifications when envelopes appear in a mailbox and match your filters.

An envelope callback is a feature that allows you to receive notifications at the specified URL when an envelope appears in the mailbox and matches the configured filters. You can set up callbacks for the mailbox to receive envelope notifications outside the platform. This is done via API. If the callback is configured, the callback URL is reachable, and the envelope triggers a callback, the system sends a callback to the specified URL with the following JSON data.

See the Glossary for DocStudio term definitions.

JSON Callback data

{
  "mailbox": "F32A3BD9-CE5B-4AC5-A2D7-C2A2E7DD6636",
  "uuid": "74acfb70-78e9-4ca5-ac73-054c72402c0a",
  "label": ["string"],
  "status": "string",
  "subject": "string",
  "receiveDate": 1676039226765,
  "expireDate": 1678631226504,
  "template": "ebeb302b-597e-4b47-9de2-5ad3a33e4385",
  "sender": "fdfde267-6558-40a9-93fd-e59529baef36"
}

Description of the JSON data

mailbox	Mailbox UUID of the mailbox that is currently processing the envelope
uuid	Envelope UUID that triggered the callback on the platform
label	List of label UUIDs assigned to a particular envelope
status	Status of the envelope. The most expected statuses are WAITING, COMPLETED, EXPIRED, CANCELLED
subject	Envelope subject
receiveDate	Envelope receiving date. Returned in UNIX time
expireDate	Envelope expiration date. Returned in UNIX time
template	UUID of the template from which the envelope was created
sender	Envelope sender UUID of the mailbox that initiated the envelope processing flow