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}

Get Custom Event Schema

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId}

200

{
  "id": "ms_f1r5Tm3ta6a4a5ch3ma",
  "related_object": "order",
  "properties": {
    "published": {
      "type": "boolean",
      "optional": true
    }
  },
  "created_at": "2024-04-29T11:25:44.458Z",
  "object": "custom-event-schema"
}

Path Parameters

projectId · string · required

Provide the unique identifier of the project.

Example:

"proj_TrlkLiH4"

customEventSchemaId · string · required

Provide the unique identifier of the custom event schema.

Example:

"ms_f1r5Tcu5T0m3v3nT5ch3ma"

Response

200

application/json

Returns the custom event schema.

Response body schema for GET /management/v1/projects/{projectId}/custom-event-schema/{customEventSchemaId}.

id · string · required

Unique identifier of the custom event schema.

Example:

"ms_oA8CawM07Q8i05Cx62U6euTK"

name · string · required

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

schema · object · required

Object containing custom event schema and its custom attributes (metadata).

Show child attributes

created_at · string<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.

Example:

"2024-03-27T08:00:09.472Z"

object · enum<string> · default: custom-event-schema · required

The type of the object represented by JSON.

Available options: custom-event-schema

Example:

"custom-event-schema"

updated_at · string<date-time>

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

Example:

"2024-03-27T08:00:09.472Z"