Notifications
The Notifications endpoints can be used for retrieving notifications or application responses and marking them as acknowledged.
Download OpenAPI specification
Notifications are our way of letting you know when something interesting happens to a document. When an interesting event occurs, we create a new Notification object. Notifications can inform you of approval numbers, document status changes, and more.
Notifications occur when a Business Process is executed on a document. Business Processes are defined in the XML document and tell Sovos which actions to apply to a document, such as mapping, signing, and transmitting. A notification is created for each Business Process update, and a document can have many notifications.
As with other API resources, you can use endpoints to retrieve an individual notification or a list of notifications. Sovos recommends retrieving all new notifications for a country and then marking them as read.
Learn how to listen for events so that your integration can automatically trigger reactions.
These are the available endpoints in the Notifications resource:
| HTTP Method | Endpoint | Description |
|---|---|---|
| GET | /v1/notifications/{countryCode} | Lists notifications pending acknowledgment for a given country. |
| PUT | /v1/notifications/{countryCode} | Marks the status of a notification as "read" or "unread". |
| PUT | /v1/notifications/{countryCode}/bulk | Marks the status of multiple notifications as "read" or "unread". |
| GET | /v1/notifications/{countryCode}/{notificationId} | Retrieves a specific notification. |