Commerce Events

Submit commerce event

POST
/beta/commerce-events

Submit a commerce event for a user (e.g. order lifecycle events for conversation routing, sales attribution, and analytics).

Authorization

ApiKeyAuth
headerAuthorization<token>

Request Body

The commerce event to submit

application/json
  1. body
eventId*string

Unique identifier for the event; used for idempotency

eventTimestamp*string

When the event occurred in the source system, not when Dixa received it

Formatdate-time
user*|

Identifies the author of the action that triggered the event (e.g. a staff member who initiated a refund).

author?|

Identifies the author of the action that triggered the event (e.g. a staff member who initiated a refund).

origin?string

Sales channel or platform origin (e.g. web, mobile, pos).

metadata?

Optional platform-specific key-value pairs for data that does not fit the typed payload.

payload*||||||||

Typed event payload. The _type field determines the event variant.

Response Body

Event accepted

Example Request
curl -X POST 'https://dev.dixa.io/beta/commerce-events' \  -H 'Authorization: <API token>' \  -H 'Content-Type: application/json' \  -d '{  "eventId": "evt_001",  "eventTimestamp": "2026-05-08T14:32:11Z",  "user": {    "userId": "04a4db4f-cd01-41e2-88cf-32c4b6079f33",    "_type": "ById"  },  "payload": {    "orderId": "ORD-9981",    "total": {      "amount": 8950,      "currency": "EUR"    },    "lineItems": [      {        "label": "Leather Derby Shoes",        "reference": "SHOE-42-BLK",        "quantity": 1,        "amount": {          "amount": 8950,          "currency": "EUR"        }      }    ],    "_type": "OrderCreated"  }}'

Empty