Skip to main content
GET
/
v1
/
{workspace}
/
event
/
{url_encoded_event_name}
/
cURL
curl -X GET "https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/" \
  --header 'Authorization: ServiceToken <token>' \
  --header 'Content-Type: application/json'
import requests

url = "https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/"

headers = {"ServiceToken <token>": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'ServiceToken <token>': '<api-key>'}};

fetch('https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "ServiceToken <token>: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("ServiceToken <token>", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/")
  .header("ServiceToken <token>", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://management-api.suprsend.com/v1/{workspace}/event/{url_encoded_event_name}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["ServiceToken <token>"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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"
}
{
  "code": 400,
  "error_code": "error",
  "type": "ValidationError",
  "message": "{\"name\": [\"This field is required.\"]}",
  "detail": {
    "name": [
      "This field is required."
    ]
  }
}
{
  "code": 401,
  "error_code": "authentication_failed",
  "type": "AuthenticationFailed",
  "message": "Invalid service token.",
  "detail": "Invalid service token."
}

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"