SUsuprsend

Create Event

Changed on

Add events and their linked schemas in SuprSend

post/v1/{workspace}/event/

Request

Path parameters

workspacestring required

Workspace slug (staging, production, etc.)

Request body

namestring 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.

descriptionstring

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

Example request

{
  "name": "USER_SIGNUP",
  "description": "Triggered whenever a new user successfully signs up on the platform",
  "payload_schema": {
    "schema": "user_signup_v1",
    "version_no": 1
  }
}

Response

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

object required

Changes

  • 5f0169085547Revision changes
    • breaking

      response property detail list-of-types was widened by adding types array and object to media type application/json of response 401

    • breaking

      removed the success response with the status

    • warning

      the request property's maxLength was set to 1024

    • info

      added the success response with the status