Account5

Action36

Action Item12

Action Item Category5

Action Item Comment2

Agent3

Announcements6

API keys5

Application4

Approval6

Artifact7

Asset4

Authentication1

Build4

Catalog instance (multiple keys)3

Catalog instance (single key)4

Catalog specification5

Category2

Channel5

Checklist6

Custom domain5

Deployment4

Deployment group4

Deployment strategy5

Dimension5

Dimension value1

Dimension Value4

Entity hook8

Event3

Inbox rules12

Link12

Log config4

Log specification5

Log template4

Namespace5

NRN5

Organization2

Package10

Parameter11

Personal access tokens5

Policy5

Provider6

Provider Specification5

Query1

Release4

Report versions8

Reports6

Role and grant5

Runtime Configuration5

Scope10

Scope type5

Service15

Suggestion8

Technology template5

User4

Workflow aliases7

Workflow definitions7

Workflow engine1

Workflow executions10

Workflow plugins2

Workflow revisions2

Workflow secrets and variables5

Workflow signals3

Workflow triggers1

Event

Read an event

Changed on Oct 15, 2026

Retrieves a single notification event by its ID.

get/notification/{id}

Request

Base URL
https://api.nullplatform.com
URL
https://api.nullplatform.com/notification/{id}
Auth
HTTP bearer

Path parameters

idstring uuid required

The notification ID, in UUID format.

Query parameters

include_resultsboolean

Whether to include results in the response.

include_contextboolean

Whether to include context in the response.

ℹ️ Note: You need a secops role to use this parameter.

Response

The operation was successful.

idstring uuid required

A system-wide unique ID for the notification, in UUID format.

nrnstring required

The NRN of the resource the notification was sent for.

sourcestring[] required

A list of sources that the notification channel will listen to. Each source represents a specific type of notification.

actionstring required

The action that generated the event, for example deployment:create or scope:write.

status'pending' | 'success' | 'fail' required

The status of the notification.

created_atstring date-time required

The ISO 8601 UTC timestamp for this notification.

updated_atstring date-time required

The ISO 8601 UTC timestamp for the last update to this notification.

tagsobject

A key-value map of tags associated with the notification.

contextobject

An object containing additional context for the notification. Only present when include_context is true, which requires a secops role.

Example response

{
  "id": "1180cd02-1c36-4274-8e7a-4483b87e8f2e",
  "nrn": "organization=1:account=2:namespace=3:application=4",
  "source": [
    "approval"
  ],
  "action": "deployment:create",
  "status": "success",
  "created_at": "2024-02-19T12:34:56Z",
  "updated_at": "2024-02-19T12:34:56Z",
  "tags": {
    "approval_id": 1234,
    "scope_slug": "development-uk-123"
  },
  "results": [
    {
      "id": "7c2d9b5e-3f61-4a0e-9d58-1b6a42e7c0f3",
      "notification_id": "1180cd02-1c36-4274-8e7a-4483b87e8f2e",
      "channel_id": 789,
      "status": "success",
      "response": "{\"statusCode\":200}",
      "created_at": "2024-02-19T12:34:56Z",
      "updated_at": "2024-02-19T12:34:56Z"
    }
  ]
}

Changes

Oct 15, 2026728d4df70ca1 Revision changes
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  added the new checklist enum value to the / response property for the response status
- warning
  added the new pending enum value to the response property for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  response property message deprecated
- info
  response property message deprecated
- info
  removed the action:instance_kill:create enum value from the response property for the response status
- info
  removed the application:create enum value from the response property for the response status
- info
  removed the audit:log enum value from the response property for the response status
- info
  removed the deployment:create enum value from the response property for the response status
- info
  removed the deployment:write enum value from the response property for the response status
- info
  removed the deployment_group:create enum value from the response property for the response status
- info
  removed the grant:create enum value from the response property for the response status
- info
  removed the instance:data enum value from the response property for the response status
- info
  removed the log:read enum value from the response property for the response status
- info
  removed the metric:data enum value from the response property for the response status
- info
  removed the metric:list enum value from the response property for the response status
- info
  removed the parameter:delete enum value from the response property for the response status
- info
  removed the parameter:notify enum value from the response property for the response status
- info
  removed the parameter:read-secrets enum value from the response property for the response status
- info
  removed the parameter:retrieve enum value from the response property for the response status
- info
  removed the parameter:store enum value from the response property for the response status
- info
  removed the scope:create enum value from the response property for the response status
- info
  removed the scope:delete enum value from the response property for the response status
- info
  removed the scope:recreate enum value from the response property for the response status
- info
  removed the scope:stop enum value from the response property for the response status
- info
  removed the scope:write enum value from the response property for the response status
- info
  removed the service:action:create enum value from the response property for the response status
- info
  removed the target_group:create enum value from the response property for the response status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history