SUsuprsend

Get Event Details

Changed on

Fetch event details and its linked schema.

get/v1/{workspace}/event/{url_encoded_event_name}/

Request

Path parameters

workspacestring required

Workspace slug (staging, production, etc.)

url_encoded_event_namestring required

URL encoded event name. Example - SHIPMENT%20ARRIVED

Response

Successfully retrieved event

namestring

Event name

descriptionstring

Description of the event

created_atstring date-time

When the event was created

$schemastring

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

Example response

{
  "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"
}

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

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status