Get Event Schemas

GET

api

events

schemas

Get Event Schemas

curl --request GET \
  --url https://api.sequenzy.com/api/v1/events/schemas \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/events/schemas', 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://api.sequenzy.com/api/v1/events/schemas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.sequenzy.com/api/v1/events/schemas"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/events/schemas")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "eventName": "ecommerce.order_placed",
  "events": [
    {
      "eventName": "ecommerce.order_placed",
      "documented": true,
      "label": "Order Placed",
      "category": "E-commerce",
      "description": "Customer placed an order",
      "documentedProviders": ["shopify", "woocommerce", "api"],
      "requestedEventName": "ecommerce.order_placed",
      "providers": [
        {
          "provider": "shopify",
          "examplePayload": {
            "provider": "shopify",
            "orderId": "820982911946154500",
            "orderNumber": 1001,
            "totalPriceCents": 8850,
            "currency": "USD",
            "financialStatus": "paid",
            "fulfillmentStatus": null,
            "orderedAt": "2026-04-02T12:00:00.000Z",
            "productNames": ["Protein Powder"],
            "itemCount": 1,
            "lineItems": [
              {
                "title": "Protein Powder",
                "variantTitle": "Vanilla",
                "quantity": 1,
                "priceCents": 8850,
                "price": "$88.50"
              }
            ]
          },
          "properties": [
            {
              "path": "totalPriceCents",
              "type": "number",
              "description": "Total in minor units (8850 = $88.50), not a decimal amount.",
              "mergeTag": "{{event.totalPriceCents}}"
            },
            {
              "path": "fulfillmentStatus",
              "type": "string | null",
              "description": "Shopify fulfillment state. Null on a newly placed order - it is set on `ecommerce.order_fulfilled`.",
              "mergeTag": "{{event.fulfillmentStatus}}"
            },
            {
              "path": "lineItems",
              "type": "object[]"
            },
            {
              "path": "lineItems[].title",
              "type": "string",
              "mergeTag": "{{event.lineItems.0.title}}"
            }
          ]
        }
      ],
      "mergeTagPrefix": "event.",
      "notes": [
        "Reference payloads are representative samples, not a contract. Providers omit fields that do not apply to a given order or product, and any extra properties you send with the event are passed through unchanged."
      ]
    }
  ]
}

{
  "success": false,
  "error": "provider must be one of shopify, woocommerce, manual, api, stripe"
}

{
  "success": false,
  "error": "Unauthorized"
}

Read what a built-in event payload actually contains: a real example payload per provider, every property path with its type, and the merge tag that resolves it. Use this before writing {{event.*}} merge tags or event property filters. An unrecognized merge tag renders as an empty string rather than an error, so a guessed property name ships silently broken. This is static reference data describing the shape of an event, not what your account has received. For a recorded payload, use Get Received Event Sample.

Request

string

Event to describe, such as ecommerce.order_placed. Legacy aliases like order.completed resolve to their current name. Omit to list every documented event.

string

Return only this provider’s payload: shopify, woocommerce, manual, api, or stripe. Omit to compare every provider that documents the event.

curl "https://api.sequenzy.com/api/v1/events/schemas?eventName=ecommerce.order_placed&provider=shopify" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response fields

string

The normalized event name that was described, or null when listing every documented event.

object[]

One entry per event. Listing mode returns summaries only; asking for a single eventName adds providers, mergeTagPrefix, and notes.

boolean

Whether a reference payload is published. false means no sample exists - it never means the event name is invalid. Custom events are fully supported and carry exactly the properties you send.

string[]

Providers with a reference payload for this event.

object[]

Per provider: examplePayload (a real sample) and properties.

object[]

Every property path, with type, the mergeTag that resolves it, and a description wherever the sample value alone is ambiguous - a null sample, an empty list, a unit that is not obvious, or a type that differs per provider.

Units and types worth knowing

Fields ending in Cents are minor units: 8850 is $88.50.
price is a preformatted display string. Use priceCents for arithmetic and comparisons.
predictedLtv is whole currency units, not cents, even though it sits next to *Cents fields.
churnRisk is a percent from 0 to 95, quantized to the nearest 5 - not a 0-1 probability.
orderId is a string on Shopify and the commerce API, and a number on WooCommerce. Compare it as a string.

Responses

{
  "success": true,
  "eventName": "ecommerce.order_placed",
  "events": [
    {
      "eventName": "ecommerce.order_placed",
      "documented": true,
      "label": "Order Placed",
      "category": "E-commerce",
      "description": "Customer placed an order",
      "documentedProviders": ["shopify", "woocommerce", "api"],
      "requestedEventName": "ecommerce.order_placed",
      "providers": [
        {
          "provider": "shopify",
          "examplePayload": {
            "provider": "shopify",
            "orderId": "820982911946154500",
            "orderNumber": 1001,
            "totalPriceCents": 8850,
            "currency": "USD",
            "financialStatus": "paid",
            "fulfillmentStatus": null,
            "orderedAt": "2026-04-02T12:00:00.000Z",
            "productNames": ["Protein Powder"],
            "itemCount": 1,
            "lineItems": [
              {
                "title": "Protein Powder",
                "variantTitle": "Vanilla",
                "quantity": 1,
                "priceCents": 8850,
                "price": "$88.50"
              }
            ]
          },
          "properties": [
            {
              "path": "totalPriceCents",
              "type": "number",
              "description": "Total in minor units (8850 = $88.50), not a decimal amount.",
              "mergeTag": "{{event.totalPriceCents}}"
            },
            {
              "path": "fulfillmentStatus",
              "type": "string | null",
              "description": "Shopify fulfillment state. Null on a newly placed order - it is set on `ecommerce.order_fulfilled`.",
              "mergeTag": "{{event.fulfillmentStatus}}"
            },
            {
              "path": "lineItems",
              "type": "object[]"
            },
            {
              "path": "lineItems[].title",
              "type": "string",
              "mergeTag": "{{event.lineItems.0.title}}"
            }
          ]
        }
      ],
      "mergeTagPrefix": "event.",
      "notes": [
        "Reference payloads are representative samples, not a contract. Providers omit fields that do not apply to a given order or product, and any extra properties you send with the event are passed through unchanged."
      ]
    }
  ]
}

{
  "success": false,
  "error": "provider must be one of shopify, woocommerce, manual, api, stripe"
}

{
  "success": false,
  "error": "Unauthorized"
}

Get Event Schemas

curl --request GET \
  --url https://api.sequenzy.com/api/v1/events/schemas \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/events/schemas', 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://api.sequenzy.com/api/v1/events/schemas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.sequenzy.com/api/v1/events/schemas"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/events/schemas")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "eventName": "ecommerce.order_placed",
  "events": [
    {
      "eventName": "ecommerce.order_placed",
      "documented": true,
      "label": "Order Placed",
      "category": "E-commerce",
      "description": "Customer placed an order",
      "documentedProviders": ["shopify", "woocommerce", "api"],
      "requestedEventName": "ecommerce.order_placed",
      "providers": [
        {
          "provider": "shopify",
          "examplePayload": {
            "provider": "shopify",
            "orderId": "820982911946154500",
            "orderNumber": 1001,
            "totalPriceCents": 8850,
            "currency": "USD",
            "financialStatus": "paid",
            "fulfillmentStatus": null,
            "orderedAt": "2026-04-02T12:00:00.000Z",
            "productNames": ["Protein Powder"],
            "itemCount": 1,
            "lineItems": [
              {
                "title": "Protein Powder",
                "variantTitle": "Vanilla",
                "quantity": 1,
                "priceCents": 8850,
                "price": "$88.50"
              }
            ]
          },
          "properties": [
            {
              "path": "totalPriceCents",
              "type": "number",
              "description": "Total in minor units (8850 = $88.50), not a decimal amount.",
              "mergeTag": "{{event.totalPriceCents}}"
            },
            {
              "path": "fulfillmentStatus",
              "type": "string | null",
              "description": "Shopify fulfillment state. Null on a newly placed order - it is set on `ecommerce.order_fulfilled`.",
              "mergeTag": "{{event.fulfillmentStatus}}"
            },
            {
              "path": "lineItems",
              "type": "object[]"
            },
            {
              "path": "lineItems[].title",
              "type": "string",
              "mergeTag": "{{event.lineItems.0.title}}"
            }
          ]
        }
      ],
      "mergeTagPrefix": "event.",
      "notes": [
        "Reference payloads are representative samples, not a contract. Providers omit fields that do not apply to a given order or product, and any extra properties you send with the event are passed through unchanged."
      ]
    }
  ]
}

{
  "success": false,
  "error": "provider must be one of shopify, woocommerce, manual, api, stripe"
}

{
  "success": false,
  "error": "Unauthorized"
}

​Request

​Response fields

​Units and types worth knowing

​Responses

Request

Response fields

Units and types worth knowing

Responses