---
title: "Order Status Change Webhook"
method: POST
path: "orderStatusUpdate"
tags: ["Webhook Events"]
---

# Order Status Change Webhook

`POST orderStatusUpdate` (webhook)

Sent when an order changes status. The payload includes the affected order identifier and its updated status.

## Payload

- object
  - `event_type` string, required
  - `event_id` string, required
  - `data` WebhookOrderStatusUpdatePayload, required
    - `order.id` integer
    - `order.status` string: The order's status after the change, in the same display form used throughout the dashboard and the order endpoints.
    - `order.previous_status` string, nullable: The status the order moved from, in lower case. Null if the order had no status before the change.
    - `order.current_status` string: The status the order moved to, in lower case. This is the same change reported by `order.status`, which gives the display form of the value.
    - `order.metadata` object, nullable: The metadata object submitted with the order, returned exactly as it was sent. Null when the order was created without metadata.
  - `timestamp` integer, required
  - `date_time` string, required

## Acknowledgement `200`

Webhook received

---

[API](https://skmtc.dev/thanks-io/apis/thanks-io-api.md) · [All operations](https://skmtc.dev/thanks-io/apis/thanks-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/thanks-io/apis/thanks-io-api/revisions/c403fbf3dc0f?raw)