NOnovu
Notifications

List all events

Changed on

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

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

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)

Headers

idempotency-keystring

A header for idempotency purposes

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

  • 951a80501fceRevision changes
    • warning

      added the new agent-email-inbox enum value to the ////// response property for the response status

    • warning

      added the new agent-email-inbox enum value to the //// response property for the response status

  • f056922796adRevision changes
    • warning

      added the new google-chat enum value to the ////// response property for the response status

    • warning

      added the new google-chat enum value to the //// response property for the response status

    • warning

      added the new photon-imessage enum value to the ////// response property for the response status

    • warning

      added the new photon-imessage enum value to the //// response property for the response status