---
title: "Add custom event to order"
method: POST
path: "/v1/order/{id}/events"
tags: ["Order"]
---

# Add custom event to order

`POST /v1/order/{id}/events`

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.

## Path parameters

- `id` string, required — Unique reference number for the order: either order.id (starts with "ord_") or order.externalId

## Request body

- AddEventInputSerializer — Expected payload for the add event endpoint.
  - `name` string, required
  - `timestamp` string, nullable — The event time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'.
  - `payload` object, nullable

## Response `200`

OK

- AddEventOutputSerializer
  - `event` EventOutputPayload, required
    - `id` string, required
    - `eventName` string, required
    - `orderId` string, required
    - `payload` object, nullable
    - `eventCreatedAt` string, required

## Other responses

- `422` — Unprocessable Content

---

[API](https://skmtc.net/usenash/apis/nash-api.md) · [All operations](https://skmtc.net/usenash/apis/nash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usenash/nash-api/revisions/09a23a95889b/schema)
