List in-app notifications

GET

/api/notifications

const url = 'http://localhost:9477/api/notifications?limit=50';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:9477/api/notifications?limit=50'

Parameters

Query Parameters

limit

Max items per page

integer format: int64

default: 50 >= 1 <= 500

Max items per page

before

Cursor: return only items with id < before (descending)

string

Cursor: return only items with id < before (descending)

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

items

required

Notifications in id-DESC order

array | null

object

body

required

Pre-rendered body text

string

count

required

Number of coalesced occurrences within the window

integer format: int64

created_at

required

First time this notification was raised

string format: date-time

fingerprint

required

Coalescing key (FNV1a hex)

string

required

Stable ULID identifier

string

kind

required

Event kind (run.failed, notify.delivery_failed, …)

string

last_occurred_at

required

Most recent occurrence

string format: date-time

occurrences

required

Most-recent timestamps (newest first), ISO8601

array | null

read_at

When the operator marked this row read; null/absent when unread

string format: date-time

run_id

required

Run that produced this notification (empty when not run-derived)

string

severity

required

Info | warn | error

string

task_name

required

Task that produced this notification (empty for daemon-level events)

string

title

required

Human-readable title

string

next_cursor

Cursor to pass as ‘before’ on the next page; empty when exhausted

string

Example

{
  "$schema": "http://localhost:9477/schemas/NotificationsListBody.json"
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

array | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "http://localhost:9477/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}