API Reference & Documentation
This page documents how to interface with the NotifyMe backend API. Integrating NotifyMe is as simple as sending standard HTTP POST requests with a JSON body from your programs, scripts, or pipelines.
POST
/api/send/{uuid}
Dispatches a notification to all active web clients currently viewing the channel corresponding to the specified uuid.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| uuid | string (uuidv4) | The unique channel identifier generated when creating a session page. Must be a valid UUIDv4. |
Request Body (JSON)
Maximum payload size: 64 KB
| Field | Type | Required | Description |
|---|---|---|---|
| title | string | Yes | The title/header of the notification card (e.g. "Build Successful"). |
| message | string | Yes | A detailed message body text detailing the nature of the alert. |
| level | string | No (defaults to "info") | Determines styling and indicators. Allowed values: info, success, warning, error. |
Notification Types & Styling
Info Level (
info)
Renders with a professional blue theme. Ideal for standard logging details or neutral info outputs.
Success Level (
success)
Renders with a green victory theme. Best for completed builds, pipeline successes, or standard confirmations.
Warning Level (
warning)
Renders with a yellow warning border. Great for soft failures, slow performance warnings, or disk space indicators.
Error Level (
error)
Renders with a prominent red danger style. Perfect for broken builds, system exceptions, or critical alerts.
HTTP Responses & Status Codes
200 OK — Message Broadcasted successfully
{
"sent": true,
"recipients": 2
}
400 Bad Request — Malformed JSON or Missing fields
{
"error": "Title and message are required fields"
}
404 Not Found — Channel doesn't exist or has no active listening browsers
{
"error": "no active listeners for this channel"
}