VOvoucherifyio
Management

Get Custom Event Schema

Retrieves a custom event schema.

📘 Custom Event Documentation

Read Custom Events article to learn how custom events work in Voucherify.

Read also the details about the Track Custom Event endpoint and the Custom Event Object.

get/management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId}

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId}
  • Auth
    API key in header X-Management-Id and API key in header X-Management-Token

Response

Returns the custom event schema.

idstring required

Unique identifier of the custom event schema.

namestring required

User-defined name of the custom event. This is also shown in Project Settings > Event Schema in the Voucherify Dashboard.

created_atstring date-time required

Timestamp representing the date and time when the custom event schema was created. The value is shown in the ISO 8601 format.

updated_atstring date-time

Timestamp representing the date and time when the custom event schema was updated. The value is shown in the ISO 8601 format.

object'custom-event-schema' required

The type of the object represented by JSON.

Example response

{
  "id": "ms_oA8CawM07Q8i05Cx62U6euTK",
  "created_at": "2024-03-27T08:00:09.472Z",
  "updated_at": "2024-03-27T08:00:09.472Z",
  "object": "custom-event-schema"
}

Changes

No recorded changes to this operation across all 1 revision of this API.