Sign in
Notifications

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.

get/organizations/{orgId}/notifications/configurations

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Query parameters

pageSizeinteger

Specifies the maximum number of Notifications to retrieve per page.

nextTokenstring

The nextToken for multi-page retrievals. It is used to fetch the next page of Notifications in a paginated list.

activeboolean

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.
eventNamestring

Use this to filter the Notifications returned - only those Notifications that are based on the Event type specified by eventName are returned.

idsstring[]

A list of specific Notification UUIDs to retrieve.

Response

Returns the list of Event Notifications

nextTokenstring

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"
    }
  ]
}

Changes

Changed in 2 of the 10 revisions of this API.222

  • 9f9e5f3dbde712See the full diff
    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b512See the full diff
    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog