Submit Event

POST /event

Submit an event notification to your workspace.

Request

curl -X POST https://api.apialerts.com/event \
  -H "Authorization: Bearer YOUR-API-KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "New user signed up",
    "channel": "signups",
    "link": "https://dashboard.example.com/users/123",
    "tags": ["signup", "organic"]
  }'

Request Body

Field	Type	Required	Description
message	string	Yes	The notification message
channel	string	No	Target channel slug. Defaults to the workspace’s default channel.
link	string	No	URL to attach to the notification. Opens when tapping the push notification.
tags	string[]	No	Array of tags for categorization and filtering

Response

200 OK

{
  "workspace": "My Workspace",
  "channel": "signups",
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "remainingQuota": 4832
}

Field	Type	Description
workspace	string	Name of the workspace the event was sent to
channel	string	Channel the event was routed to
uuid	string	Unique identifier for the event
remainingQuota	number	Remaining monthly event quota

Errors

Status	Description
400	Invalid request body — missing message or validation error
401	Invalid or missing API key
429	Monthly event quota exceeded