Notifications

Manage in-app notifications for endpoint failures, cron job alerts, and important system updates.

Base URL

https://api.hookwatch.dev/v1/notifications

The Notification Object

Json

Notification Types

endpoint_failure

Webhook delivery failed after all retries

cron_failure

Cron job execution failed

usage_warning

Approaching plan limits

system

Platform updates and announcements

List Notifications

Retrieve your notifications with optional filtering.

GET /v1/notifications

Query Parameters

FieldTypeDescription
limitnumberMaximum notifications to return (default: 20, max: 100)
offsetnumberNumber of notifications to skip for pagination
unread_onlybooleanOnly return unread notifications

Response

Json

Get Unread Count

Get the number of unread notifications.

GET /v1/notifications/unread-count

Response

Json

Mark as Read

Mark a single notification as read.

PUT /v1/notifications/:id/read

Mark All as Read

Mark all notifications as read.

PUT /v1/notifications/read-all

Delete Notification

Delete a single notification.

DELETE /v1/notifications/:id

Bulk Delete

Delete multiple notifications at once.

DELETE /v1/notifications/bulk

Request Body

FieldTypeRequiredDescription
idsstring[]YesArray of notification IDs to delete

Tips

  • Poll the unread-count endpoint periodically to show badge counts in your UI
  • Use the data field to link directly to the relevant resource
  • Configure notification preferences in your dashboard settings

Related