Sign in
Event

Read an event

Retrieves a single notification event by its ID.

get/notification/{id}

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.

sourcestring[] required

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

action'action:instance_kill:create' | 'application:create' | 'audit:log' | 'deployment:create' | 'deployment:write' | 'deployment_group:create' | 'grant:create' | 'instance:data' | 'log:read' | 'metric:data' | 'metric:list' | 'parameter:delete' | 'parameter:notify' | 'parameter:read-secrets' | 'parameter:retrieve' | 'parameter:store' | 'scope:create' | 'scope:delete' | 'scope:recreate' | 'scope:stop' | 'scope:write' | 'service:action:create' | 'target_group:create'

The name of the action originated by the source.

status'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

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

tagsobject

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

contextobject required

An object containing additional context for the notification.

Example response

{
  "id": "1180cd02-1c36-4274-8e7a-4483b87e8f2e",
  "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": [
    {
      "my-slack-channel": {
        "ok": true,
        "id": "123456"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.