USusenash
Order

Add custom event to order

Changed on

Add a custom event to an order's event timeline. Rate limited to 3 requests per second per order with a max payload of 1KB.

post/v1/order/{id}/events

Request

Path parameters

idstring required

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

Example:ord_1234567890

Request body

namestring nullable

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

customEventDefinitionIdstring nullable

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.

customEventDefinitionKeystring nullable

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.

timestampstring nullable

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

payloadobject nullable

Response

OK

Changes

  • e3713837c5c9Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      request property list-of-types was widened by adding types null to media type application/json