Event

List events

List all notification events.

get/notification/

Query parameters

nrnstring required

Filters notification events that match or are more specific than the provided NRN.

show_descendantsboolean

Whether to include notification events from descendant resources of the provided NRN.

include_resultsboolean

Whether to include results in the response.

sourcestring[]

Filters notification events by their source. You can select one or more sources from the list.

Note: In the Request panel, click and drag or use <kbd>Ctrl</kbd> / <kbd>Cmd</kbd> + click to select multiple sources.

status'success' | 'fail'

Filters notification events by their status.

Response

The operation was successful.

Example response

{
  "results": [
    {
      "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.