Skip to content
Boson

API

API reference

Core HTTP routes for events, inbox, and read state.

Base URL: https://api.getboson.com

Authenticate with x-api-key on HTTP routes. The WebSocket accepts apiKey as a query parameter.

Create an event

POST /v1/events

{
  "channel": "in_app",
  "subscriberId": "user_123",
  "title": "Deploy finished",
  "body": "api-7f3c is live"
}

Returns 202 with the notification id. Supported channels: in_app, email, sms, push.

Inbox

GET /v1/inbox/:subscriberId - latest in-app notifications for that subscriber.

Mark read

PATCH /v1/notifications/:id/read - sets read_at on the notification.

Live socket

GET /v1/ws/:subscriberId?apiKey=... upgrades to a WebSocket. In-app deliveries for that subscriber are pushed as JSON messages.

Health

GET /health does not require an API key.