Skip to main content
POST
Create Event

Authorizations

Authorization
string
header
required

Pass as Authorization: ServiceToken <token>. You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.

Path Parameters

workspace
string
required

Workspace slug (staging, production, etc.)

Body

application/json
name
string
required

Unique Identifier of the Event. Event names are normalized (whitespace squished, illegal characters removed) and stored in upper case, except names starting with ss_ or SS_, which keep their case. Names starting with $ are reserved by SuprSend and rejected.

Maximum string length: 1024
Example:

"USER_SIGNUP"

description
string

Description of the event. Can be used to describe which action this event is linked to.

Example:

"Triggered whenever a new user successfully signs up on the platform"

payload_schema
object

Response

Event created (or re-activated/updated if an event with the same name already exists)

The response is of type object.