Skip to main content
POST
Add custom event to order

Limits

  • Rate limits: Max 3 requests/second
  • Size limit: Request body must not exceed 1kb

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Unique reference number for the order: either order.id (starts with "ord_") or order.externalId

Example:

"ord_1234567890"

Body

application/json

Expected payload for the add event endpoint.

Exactly one of name / customEventDefinitionId must be supplied — both-set and neither-set are rejected with CUSTOM_EVENT_DEFINITION_REFERENCE_INVALID. Neither can be marked required here, so that rule is enforced by the service layer (resolve_custom_event_reference) rather than by this schema.

name
string | null

A free-form event name. Mutually exclusive with customEventDefinitionId.

customEventDefinitionId
string | null

The id of a pre-defined custom event in your org's catalog. The definition's immutable key becomes the event name. Mutually exclusive with name.

timestamp
string | null

The event time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'. Defaults to now.

Pattern: (\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).?(\d)*Z?
payload
Payload · object | null

Response

OK

event
EventOutputPayload · object
required