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

Identify the event

Send exactly one of these fields to say which event you’re adding: For a catalog event, Nash records the definition’s key as the event’s name, whichever of the two catalog fields you sent. Workflows and notifications listening for that event fire the same way in both cases. Prefer the key: it’s what the Portal shows, and it stays the same if a definition is archived and a new one is created with the same key, while the ID changes.
See Match an event from your catalog for how catalog events drive workflows.

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 / customEventDefinitionKey must be supplied — none-set and more-than-one-set are rejected with CUSTOM_EVENT_DEFINITION_REFERENCE_INVALID. None 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 and customEventDefinitionKey.

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 and customEventDefinitionKey.

customEventDefinitionKey
string | null

The key of a pre-defined custom event in your org's catalog (the Event key shown under Orchestrate > Custom Events in the Portal). Resolves to that definition and emits the key as the event name. Mutually exclusive with name and customEventDefinitionId.

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