Skip to main content

Receive a notification

Here we provide the shape of the HTTP POST request that you will receive upon being notified of activity on your NRNs.

Header Parameters
np-source string REQUIRED

Possible values: [approval, service]

The same value that provided in the source field of the body but available as a header for filtering purposes.

np-event REQUIRED

The same value that provided in the event field of the body but available as a header for filtering purposes.

Request Body
id integer REQUIRED

A system-wide unique ID representing the notification

source string REQUIRED

The system that is emitting this notifications, for example approval or service.

event string REQUIRED

The name of the event originated by the source, for example deployment:create.

created_at string REQUIRED

The ISO 8859 UTC date for this notification

notification object REQUIRED

An object containing the notification. The content depends on the source field of this notification.