Notifications

List all events

List all notification events (triggered events) for the current environment. This API supports filtering by channels, templates, emails, subscriberIds, transactionId, topicKey, severity, contextKeys. Checkout all available filters in the query section. This API returns event triggers, to list each channel notifications, check messages APIs.

get/v1/notifications

Query parameters

channelsChannelTypeEnum[]

Array of channel types

templatesstring[]

Array of template IDs or a single template ID

emailsstring[]

Array of email addresses or a single email address

searchstring

Search term (deprecated)

subscriberIdsstring[]

Array of subscriber IDs or a single subscriber ID

severitystring[]

Array of severity levels or a single severity level

pagenumber

Page number for pagination

limitnumber

Limit for pagination

transactionIdstring

The transaction ID to filter by

topicKeystring

Topic Key for filtering notifications by topic

subscriptionIdstring

Subscription ID for filtering notifications by subscription

contextKeysstring[]

Filter by exact context keys, order insensitive (format: "type:id")

afterstring

Date filter for records after this timestamp. Defaults to earliest date allowed by subscription plan

beforestring

Date filter for records before this timestamp. Defaults to current time of request (now)

Response

hasMoreboolean required

Indicates if there are more activities in the result set

pageSizenumber required

Page size of the activities

pagenumber required

Current page of the activities

Changes

Changed in 5 of the 13 revisions of this API.265

  • 8bc1670bbd1322See the full diff
    • added the new novu-web-chat enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new novu-web-chat enum value to the //// response property for the response status

      response-property-enum-value-added

    • removed the novu-agent-chat enum value from the ////// response property for the response status

      response-property-enum-value-removed

    • removed the novu-agent-chat enum value from the //// response property for the response status

      response-property-enum-value-removed

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

  • d7137c47680a22See the full diff
    • added the new novu-agent-chat enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new novu-agent-chat enum value to the //// response property for the response status

      response-property-enum-value-added

    • removed the novu-web-chat enum value from the ////// response property for the response status

      response-property-enum-value-removed

    • removed the novu-web-chat enum value from the //// response property for the response status

      response-property-enum-value-removed

    • added the new grafana enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new grafana enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new novu-web-chat enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new novu-web-chat enum value to the //// response property for the response status

      response-property-enum-value-added

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

    • added the new ruach-sms enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new ruach-sms enum value to the //// response property for the response status

      response-property-enum-value-added

  • 2e115ea8160c161See the full diff
    • added the new anypost enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new anypost enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new line enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new line enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new opsgenie enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new opsgenie enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new pagerduty enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new pagerduty enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new sendblue enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new sendblue enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new tool enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new tool enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new tool-webhook enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new tool-webhook enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the new webex-messaging enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new webex-messaging enum value to the //// response property for the response status

      response-property-enum-value-added

    • added the enum value tool to the property items/ of the query request parameter channels

      request-parameter-property-enum-value-added