Skip to main content
POST
/
event
Submit an event
curl --request POST \
  --url https://api.apialerts.com/event \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "user.signup",
  "channel": "developers",
  "message": "New user signed up",
  "link": "https://dashboard.example.com/users/123",
  "tags": [
    "signup",
    "organic"
  ]
}
'
{
  "workspace": "My Workspace",
  "channel": "developers",
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "remainingQuota": 4832
}

Authorizations

​
Authorization
string
header
required

Workspace API key. Found in the workspace settings page of the dashboard.

Body

application/json

The event payload to submit.

​
message
string
required

The notification message body. This is the main content shown in push notifications.

​
event
string | null

The event name identifier. Used by routers to match and forward events to external destinations (e.g. "user.signup", "payment.failed").

​
channel
string | null

The channel to deliver the event to. If omitted, the workspace default channel is used. Channel must exist in the workspace.

​
title
string | null

A custom title for the push notification. Overrides the default event name display.

​
link
string<uri> | null

A URL to attach to the event. Tapping the notification on mobile will open this link.

​
tags
string[] | null

Tags for categorizing and filtering events.

​
data
object

Arbitrary JSON payload attached to the event. Useful for router destinations that forward structured data.

Response

Event submitted successfully.

Confirmation of a successfully submitted event.

​
workspace
string | null

Workspace name the event was delivered to.

​
channel
string | null

Channel name the event was delivered to.

​
uuid
string<uuid> | null

Unique event identifier (UUID v4).

​
remainingQuota
integer<int64> | null

Remaining event quota in the current billing period.

​
error
string | null

A warning or non-fatal error message, if any.

​
errors
string[] | null

List of validation warnings (e.g. message too long, invalid URL, tags format).