List Notifications
Retrieve a list of Event Notifications for the specified Organization.
This endpoint retrieves a list of all Event Notifications for the Organization identified by its UUID. The list can be paginated for easier management. The list also supports filtering by parameters such as Notification UUID.
Path parameters
The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
Query parameters
Specifies the maximum number of Notifications to retrieve per page.
The nextToken for multi-page retrievals. It is used to fetch the next page of Notifications in a paginated list.
A Boolean flag indicating whether to retrieve only active or only inactive Notifications.
- TRUE - only active Notifications are returned.
- FALSE - only inactive Notifications are returned.
Use this to filter the Notifications returned - only those Notifications that are based on the Event type specified by eventName are returned.
A list of specific Notification UUIDs to retrieve.
Response
Returns the list of Event Notifications
Example response
{
"data": [
{
"name": "Commitment has under 10% remaining",
"description": "Commitment amount fell below 10%",
"active": true,
"eventName": "configuration.commitment.updated",
"calculation": "(new.amountSpent >= ((new.amount*90)/100)) \nAND ((old.amountSpent <= ((old.amount*90)/100)) OR (old.amountSpent == null))",
"code": "commitment_under_10_percent"
}
]
}