---
title: "Add Custom Order Events"
method: POST
path: "/orders/{order_handle}/events"
tags: ["Orders"]
---

# Add Custom Order Events

`POST /orders/{order_handle}/events`

## Request

- Base URL: `https://v3.api.hypertrack.com`
- URL: `https://v3.api.hypertrack.com/orders/{order_handle}/events`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/orders/:order_handle/events/post.ts> (a function with typed inputs; its response is checked against the schema)

Add Custom order events to an order identified by order handle

## Path parameters

- `order_handle` string, required

## Request body

- CustomOrderEventRequest
  - `events` CustomOrderEvent[], required: List of order events
    - `type` string, required: Name of event
    - `recorded_at` string, required: Timestamp of when the event occurred
    - `metadata` object, nullable: Any additional metadata to associate with the event
    - `location` union: Location where the event occurred
      - PointLocation1
        - `geometry` PointLocationGeometry, required
          - `type` 'Point', required: Point Geometry type
          - `coordinates` number[], required: Location coordinates represented as [longitude, latitude].
        - `accuracy` number, nullable: Accuracy in meters for the location
      - unknown
    - `address` string, nullable: Address of the location where the event occurred
    - `attachments` union[], nullable: List of attachments in event
      - union
        - ImageAttachmentUpload
          - `type` 'image', required: Type of attachment
          - `caption` string, required: Caption for the image
          - `data` string, required: Image as base64 text
          - `attachment_id` string, uuid, nullable: String representing the ID of the attachment
        - NoteAttachmentUpload
          - `type` 'note', required: Type of attachment
          - `data` string, required: Text for the note
          - `attachment_id` string, uuid, nullable: String representing the ID of the attachment
        - SignatureAttachmentUpload
          - `type` 'signature', required: Type of attachment
          - `data` string, required: Signature as base64 text
          - `attachment_id` string, uuid, nullable: String representing the ID of the attachment

## Response `201`

Successful response

- unknown

## Other responses

- `400`: Validation error
- `401`: Authentication error
- `404`: Not found

---

[API](https://skmtc.dev/hypertrack/apis/hypertrack-api.md) - [All operations](https://skmtc.dev/hypertrack/apis/hypertrack-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hypertrack/apis/hypertrack-api/revisions/389326c4c9c8?raw)