NOnovu
Notifications

Retrieve an event

Changed on

Retrieve an event by its unique key identifier notificationId. Here notificationId is of mongodbId type. This API returns the event details - execution logs, status, actual notification (message) generated by each workflow step.

get/v1/notifications/{notificationId}

Request

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

Path parameters

notificationIdstring required

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

_idstring

Unique identifier of the notification

_environmentIdstring required

Environment ID of the notification

_organizationIdstring required

Organization ID of the notification

_subscriberIdstring required

Subscriber ID of the notification

transactionIdstring required

Transaction ID of the notification

_templateIdstring

Template ID of the notification

_digestedNotificationIdstring

Digested Notification ID

createdAtstring

Creation time of the notification

updatedAtstring

Last updated time of the notification

channelsStepTypeEnum[]

Channels of the notification

payloadobject

Payload of the notification

tagsstring[]

Tags associated with the notification

controlsobject

Controls associated with the notification

toobject

To field for subscriber definition

severity'high' | 'medium' | 'low' | 'none'

Override the severity of the workflow

criticalboolean

Criticality of the notification

contextKeysstring[]

Context (single or multi) in which the notification was sent

Example response

{
  "jobs": [
    {
      "overrides": {
        "workflowId": "some_wf_id",
        "stepId": "some_wf_id"
      }
    }
  ]
}

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