Publish the tracking plan

Replaces the organization’s known events with the ones your code declares, so the dashboard can offer them. Sent by @stetcms/vite and stet sync.

PUT/events/schema

Request body

requiredapplication/json

eventsobject[]required

Show properties

Array of object

namestringrequired

min length 1

propsstring[]required

Responses

200OK

syncedintegerrequired

min -9007199254740991 · max 9007199254740991

401401

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Authentication required. Pass an organization API key in the `x-api-key` header."

dataany

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

429429

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Too many requests. Try again shortly."

dataany

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

Request

curl -X PUT "https://stetcms.com/api/v1/events/schema" \
  -H "Content-Type: application/json" \
  -d '{
  "events": [
    {
      "name": "string",
      "props": [
        "string"
      ]
    }
  ]
}'

const response = await fetch("https://stetcms.com/api/v1/events/schema", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "events": [
    {
      "name": "string",
      "props": [
        "string"
      ]
    }
  ]
})
});

Response

{
  "synced": 0
}