---
title: "Get event schemas"
method: GET
path: "/events/schemas"
tags: ["Events"]
---

# Get event schemas

`GET /events/schemas`

Returns the published payload of a built-in event - a real example payload per provider, plus every property path with its type, the merge tag that resolves it, and a description wherever the example alone is ambiguous (a null sample, an empty list, a unit that is not obvious, or a type that differs per provider). Omit eventName to list every documented event. Static reference data describing the shape of an event, not what the account has received. An event with no published payload returns documented false; it is still valid to trigger and to build a sequence on, because custom events carry exactly the properties you send.

## Query parameters

- `eventName` string
- `provider` 'shopify' | 'woocommerce' | 'manual' | 'api' | 'stripe'

## Response `200`

Event schemas returned

- object
  - `success` boolean
  - `eventName` string, nullable — Normalized name of the event described, or null when listing every documented event.
  - `events` EventSchema[]
    - `eventName` string — Normalized event name - the name to trigger and to configure triggers on.
    - `requestedEventName` string — The name as asked for, before alias normalization.
    - `documented` boolean — Whether a reference payload is published. False never means the event name is invalid - custom events carry exactly the properties you send and are never rejected.
    - `label` string, nullable
    - `category` string, nullable
    - `description` string, nullable
    - `documentedProviders` string[] — Providers with a reference payload for this event.
    - `providers` object[] — Single-event mode only. One entry per provider.
      - `provider` 'shopify' | 'woocommerce' | 'manual' | 'api' | 'stripe'
      - `examplePayload` object — A representative sample payload, not a contract.
      - `properties` object[]
        - `path` string — Dot path into the payload. Object array elements use [], e.g. lineItems[].priceCents.
        - `type` string — Human-readable type, e.g. string, string | null, object[].
        - `description` string — Present only where the sample value alone is ambiguous.
        - `mergeTag` string — Merge tag that resolves this path. Scalar paths only.
    - `mergeTagPrefix` string
    - `notes` string[]
  - `note` string — Present in listing mode only.

## Other responses

- `400` — Unknown provider
- `401` — Unauthorized

---

[API](https://skmtc.net/sequenzy/apis/sequenzy-api.md) · [All operations](https://skmtc.net/sequenzy/apis/sequenzy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sequenzy/sequenzy-api/revisions/9da9d1816e27/schema)