POST/schemas

Create an event schema

Requires Bearer authentication. See Authentication.

Request body

Field	Type	Description
`eventType`required	string	—
`schemaDefinition`required	object (record)	—
`description`	string	—
`examplePayload`	object (record)	—

Responses

201 201

Field	Type	Description
`id`required	string (uuid)	—
`eventType`required	string	—
`version`required	number	—
`schemaDefinition`required	object (record)	—
`description`required	string	—
`examplePayload`required	object (record)	—
`status`required	"DRAFT" \| "ACTIVE" \| "DEPRECATED"	—
`createdAt`required	string (date-time)	—
`updatedAt`required	string (date-time)	—

400 400

Field Type Description

errorrequired object —

`code`required	string	—
`message`required	string	—
`details`	any	—

Errors

Errors use the standard envelope. See Errors for codes, status mappings, and retry semantics.

Request

curl -X POST https://api.pushrail.io/schemas \
  -H "Authorization: Bearer pk_live_..." \
  -H "Content-Type: application/json" \
  -d '  {
    "eventType": "string",
    "schemaDefinition": {},
    "description": "string",
    "examplePayload": {}
  }'

Response · 201201

{
  "id": "00000000-0000-0000-0000-000000000000",
  "eventType": "string",
  "version": 0,
  "schemaDefinition": {},
  "description": "string",
  "examplePayload": {},
  "status": "DRAFT",
  "createdAt": "2026-10-27T16:42:41.343Z",
  "updatedAt": "2026-10-27T16:42:41.343Z"
}

Response · 400400

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}