Skip to content

Notifications

beginner

Mark notifications as read and dismiss them.

Mark as read

POST/v1/notifications/{notification_id}/read

Mark a single notification as read.

notification_idstringrequired

Notification ID (path parameter).

200Response
{
  "message": "Notification marked as read"
}

Mark all as read

POST/v1/notifications/read-all

Mark all notifications as read.

200Response
{
  "message": "All notifications marked as read"
}

Dismiss notification

DELETE/v1/notifications/{notification_id}

Dismiss (delete) a single notification.

notification_idstringrequired

Notification ID (path parameter).

200Response
{
  "message": "Notification dismissed"
}

Next steps

  • Webhooks — Get real-time event notifications via HTTP
  • Usage — Monitor consumption that triggers notifications