Notifications

Retrieve an event

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}

Path parameters

notificationIdstring required

Headers

idempotency-keystring

A header for idempotency purposes

Response

_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[]

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'

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

Changed in 5 of the 12 revisions of this API.264

Aug 30, 202624e82408dec722See the full diff
- ●
  added the new novu-web-chat enum value to the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new novu-web-chat enum value to the jobs/items/providerId response property for the response status 200
  response-property-enum-value-added
- ○
  removed the novu-agent-chat enum value from the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the novu-agent-chat enum value from the jobs/items/providerId response property for the response status 200
  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
Aug 16, 2026c2b2fa0d5d4822See the full diff
- ●
  added the new novu-agent-chat enum value to the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new novu-agent-chat enum value to the jobs/items/providerId response property for the response status 200
  response-property-enum-value-added
- ○
  removed the novu-web-chat enum value from the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the novu-web-chat enum value from the jobs/items/providerId response property for the response status 200
  response-property-enum-value-removed
Jul 31, 20268092e41edd574See the full diff
- ●
  added the new grafana enum value to the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new grafana enum value to the jobs/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new novu-web-chat enum value to the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new novu-web-chat enum value to the jobs/items/providerId response property for the response status 200
  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
Jul 26, 2026ab1c5d528f972See the full diff
- ●
  added the new ruach-sms enum value to the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new ruach-sms enum value to the jobs/items/providerId response property for the response status 200
  response-property-enum-value-added
Jul 21, 2026c69777f6018416See the full diff
- ●
  added the new anypost enum value to the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new anypost enum value to the jobs/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new line enum value to the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new line enum value to the jobs/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new opsgenie enum value to the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new opsgenie enum value to the jobs/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new pagerduty enum value to the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new pagerduty enum value to the jobs/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new sendblue enum value to the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new sendblue enum value to the jobs/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new tool enum value to the channels/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new tool enum value to the jobs/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new tool-webhook enum value to the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new tool-webhook enum value to the jobs/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new webex-messaging enum value to the jobs/items/executionDetails/items/providerId response property for the response status 200
  response-property-enum-value-added
- ●
  added the new webex-messaging enum value to the jobs/items/providerId response property for the response status 200
  response-property-enum-value-added

Full history