GET
/
v1
/
{workspace}
/
event
/
{url_encoded_event_name}
/
cURL
curl -X GET "https://api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/" \
  --header 'Authorization: ServiceToken <token>' \
  --header 'Content-Type: application/json'
{
  "name": "user_signup",
  "description": "Triggered whenever a new user successfully signs up on the platform",
  "payload_schema": {
    "schema": "user_signup_v1",
    "version_no": 1
  },
  "created_at": "2025-08-27T09:30:57.945326Z",
  "$schema": "https://schema.suprsend.com/event/v1/schema.json"
}

Authorizations

​
ServiceToken <token>
string
header
required

You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.

Path Parameters

​
workspace
string
required

Workspace slug (staging, production, etc.)

​
url_encoded_event_name
string
required

URL encoded event name. Example - SHIPMENT%20ARRIVED

Response

Successfully retrieved event

​
name
string

Event name

Example:

"user_signup"

​
description
string

Description of the event

Example:

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

​
payload_schema
object
​
created_at
string<date-time>

When the event was created

Example:

"2025-08-27T09:30:57.945326Z"

​
$schema
string

JSON Schema reference for how the event API call should be structured.

Example:

"https://schema.suprsend.com/event/v1/schema.json"