Envelope callbacks

Written by Анатолій

Updated 5 days ago

Envelope callback is a functionality which allows receiving notifications to the respective URL in case of envelope appearance in the mailbox and according to configured filters. You can set up callbacks for the mailbox to receive envelope notifications outside of our platform. This is done via API. If the callback is configured, the link to receive callbacks is reachable, and the envelope is triggered callback received the system sends a callback to the respective link with the following JSON data.

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, a mailbox that is currently processing the envelope
uuid	Envelope UUID, which triggered the callback on the platform
label	List of label UUIDs which assigned to a particular envelope
status	Status of the envelope. Most expected statuses are WAITING, COMPLETED, EXPIRED, CANCELLED
subject	Envelope subject
receiveDate	Envelope receiving date. Retrieves in UNIX time
expireDate	Expiration date of the envelope. Retrieves in UNIX time
template	UUID of the template from which the envelope has been created
sender	Envelope sender UUID, mailbox that initiated the envelope processing flow

Did this answer your question?