Notifications Domain

Notifications API

Push notifications and notification management endpoints

API Prefix

/api/notifications

Every endpoint hangs off this prefix so you can compose requests consistently.

Endpoint coverage

5

curated routes spanning common workflows

Playground ready

Deep link directly into the playground with your preferred method and path.

Open in Playground

Capabilities

What you can simulate

Mix and match endpoints to validate dashboards, onboarding flows, error states, and integration docs before touching production systems.

1

Digest + real-time notification modes

2

Channel preferences per user

3

Push/pull delivery receipts

4

Templating variables + previews

5

Throttling + quiet-hour policies

6

Incident + escalation ladders

Endpoints

Available routes

Each endpoint responds with JSON objects modeled after production systems, complete with pagination, filtering, and optional latency controls for stress testing.

GET

/api/notifications?user_id=user_123

Try it
GET

/api/notifications?user_id=user_123&unread_only=true

Try it
POST

/api/notifications

Try it
PATCH

/api/notifications

Try it
DELETE

/api/notifications?notification_id=notif_1

Try it
notifications

Rehearse notification strategies

Preview multi-channel alerts, digests, and escalation paths before wiring production systems.