AurionAI Docs

Notifications

Manage notification preferences, quiet hours, and delivery channels via the Aurion API.

Notifications

The Notifications API (v2) manages in-app notifications, email delivery preferences, quiet hours, and notification history for support agents.

List Notifications

cURL
curl "https://apps.aurionai.net/api/v2/notifications?read=false&limit=20" \
  -H "X-API-Key: ak_live_xxxx"

Response:

{
  "data": [
    {
      "id": "notif_abc123",
      "type": "ticket_assigned",
      "title": "New ticket assigned to you",
      "body": "Ticket #1042: VPN not connecting",
      "read": false,
      "created_at": "2026-03-08T10:30:00Z"
    }
  ],
  "total": 15,
  "limit": 20,
  "offset": 0
}

Query Parameters:

ParameterTypeDescription
readbooleanFilter by read/unread
typestringFilter by notification type
limitintegerResults per page (default: 25, max: 100)
offsetintegerNumber of results to skip

Mark All as Read

curl -X POST "https://apps.aurionai.net/api/v2/notifications/read-all" \
  -H "X-API-Key: ak_live_xxxx"

Mark Single Notification as Read

curl -X POST "https://apps.aurionai.net/api/v2/notifications/notif_abc123/read" \
  -H "X-API-Key: ak_live_xxxx"

Returns 204 No Content on success, or 404 if the notification does not exist.

Notification Preferences

Control which events generate notifications and through which channels:

Get preferences
curl "https://apps.aurionai.net/api/v2/notifications/preferences" \
  -H "X-API-Key: ak_live_xxxx"

Response:

{
  "ticket_assigned": {"in_app": true, "email": true},
  "ticket_updated": {"in_app": true, "email": false},
  "ticket_escalated": {"in_app": true, "email": true},
  "sla_approaching": {"in_app": true, "email": true},
  "csat_received": {"in_app": true, "email": false},
  "mention": {"in_app": true, "email": true}
}
Update preferences
curl -X PUT "https://apps.aurionai.net/api/v2/notifications/preferences" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "ticket_updated": {"in_app": true, "email": true},
    "csat_received": {"in_app": false, "email": false}
  }'

Quiet Hours

Suppress non-urgent notifications during off-hours:

Get quiet hours
curl "https://apps.aurionai.net/api/v2/notifications/quiet-hours" \
  -H "X-API-Key: ak_live_xxxx"
Update quiet hours
curl -X PUT "https://apps.aurionai.net/api/v2/notifications/quiet-hours" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "timezone": "Europe/Brussels",
    "start": "20:00",
    "end": "08:00",
    "days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
    "allow_urgent": true
  }'

Notifications received during quiet hours are batched and delivered as a digest email when quiet hours end.

Delivery Log

View the delivery history for all notifications:

curl "https://apps.aurionai.net/api/v2/notifications/delivery-log?limit=20" \
  -H "X-API-Key: ak_live_xxxx"

Delivery Statistics

curl "https://apps.aurionai.net/api/v2/notifications/delivery-log/stats?start_date=2026-03-01&end_date=2026-03-08" \
  -H "X-API-Key: ak_live_xxxx"

Export Delivery Log

Export delivery data as CSV:

curl "https://apps.aurionai.net/api/v2/notifications/delivery-log/stats/export?start_date=2026-03-01&end_date=2026-03-08" \
  -H "X-API-Key: ak_live_xxxx" \
  -o delivery-log.csv

Unsubscribe

Each notification email includes an unsubscribe link. The unsubscribe endpoint is public (no authentication required):

GET https://apps.aurionai.net/api/v2/notifications/unsubscribe?token=...

Available Event Types

List all notification event types:

curl "https://apps.aurionai.net/api/v2/notifications/events" \
  -H "X-API-Key: ak_live_xxxx"

Toggle Event Enabled/Disabled

Enable or disable a notification event type for the tenant. Transactional events cannot be disabled.

curl -X PATCH "https://apps.aurionai.net/api/v2/notifications/events/ticket_assigned" \
  -H "X-API-Key: ak_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": false
  }'

Response:

{
  "event_key": "ticket_assigned",
  "enabled": false
}

Required Scopes

ScopeEndpoints
notifications:readGET /v2/notifications, GET /v2/notifications/preferences, GET /v2/notifications/quiet-hours, GET /v2/notifications/delivery-log, GET /v2/notifications/delivery-log/stats, GET /v2/notifications/events
notifications:writePOST /v2/notifications/read-all, POST /v2/notifications/:id/read, PUT /v2/notifications/preferences, PUT /v2/notifications/quiet-hours, PATCH /v2/notifications/events/:key

On this page