Order Status Changed Event

Webhook

POST

orderStatusChanged

Triggered when an order's status changes. This webhook notifies your system of order lifecycle events, enabling real-time updates for order tracking, notifications, and fulfillment workflows.

Status Transitions

Orders follow this lifecycle:

PLACED → APPROVED (payment confirmed)

APPROVED → SHIPPED (order dispatched)

SHIPPED → DELIVERED (order completed)

Any status → CANCELLED (order cancelled)

Webhook Security

All webhooks include a signature header (X-Webhook-Signature) for verification. See our webhook security guide for implementation details.

Request

Query Params

Header Params

Cookie Params

Body Params application/jsonRequired

Examples

Order approved after paymentOrder shipped for deliveryOrder cancelled by user

{
    "eventId": "evt_9f4a8b3c-2d5e-6f7g-8h9i-0j1k2l3m4n5o",
    "eventType": "order.statusChanged",
    "timestamp": "2024-12-16T10:30:00Z",
    "data": {
        "order": {
            "id": "019b4139-1234-7abc-8def-123456789abc",
            "petId": "019b4132-70aa-764f-b315-e2803d882a24",
            "userId": "019b4138-e0af-70b9-8f0c-6ea97d495dfa",
            "status": "APPROVED",
            "totalAmount": "125.50",
            "currency": "USD",
            "createdAt": "2024-12-16T09:00:00Z",
            "updatedAt": "2024-12-16T10:30:00Z"
        },
        "previousStatus": "PLACED",
        "newStatus": "APPROVED",
        "changedAt": "2024-12-16T10:30:00Z",
        "changedBy": "system"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Order approved after paymentOrder shipped for deliveryOrder cancelled by user

curl --location --globoff 'https://your-api-server.com?q_on_gp=q_on_gp_value&query_same_1=query_same_1_gp&q_on_gp_request_off=q_on_gp_request_off_value&glo_qparam_use_glo={{id_glo}}&glo_qparam_use_env={{id_env}}&glo_qparam_use_prior={{priority_env}}' \
--header 'h_on_gp: h_on_gp_value' \
--header 'header_same_1: header_same_1_gp' \
--header 'plat-form: {{header}}' \
--header 'h_on_gp_request_off: h_on_gp_case_off_value' \
--header 'glo_hparam_use_glo: {{id_glo}}' \
--header 'glo_hparam_use_env: {{id_env}}' \
--header 'glo_hparam_use_prior: {{priority_env}}' \
--header 'header_long: l=eBO-G2Fng9CH5uxF2Ofahurza77OSIOYYuPzaNbMiOCP_Xfp5gxlW6pndVL9C31Vh6DWR3-82bJHBeYBcIfEiOp2AJ-YF8Mmnl=eBO-G2Fng9CH5uxF2Ofahurza77OSIOYYuPzaNbMiOCP_Xfp5gxlW6pndVL9C31Vh6DWR3-82bJHBeYBcIfEiOp2AJ-YF8Mmn=end' \
--header 'Cookie: c_on_gp=c_on_gp_value;c_on_gp_request_off=c_on_gp_request_off_value;c_on_gp=c_on_gp_value;cookie_same_1=cookie_same_1_gp;cookie_long=l=eBO-G2Fng9CH5uxF2Ofahurza77OSIOYYuPzaNbMiOCP_Xfp5gxlW6pndVL9C31Vh6DWR3-82bJHBeYBcIfEiOp2AJ-YF8Mmn;c1=cookieInGlobalCookie;c_on_gp_request_off=c_on_gp_request_off_value;glo_cparam_use_glo={{id_glo}};glo_cparam_use_env={{id_env}};glo_cparam_use_prior={{priority_env}};c1=cookieInGlobalHeader' \
--header 'Content-Type: application/json' \
--data '{
    "eventId": "evt_9f4a8b3c-2d5e-6f7g-8h9i-0j1k2l3m4n5o",
    "eventType": "order.statusChanged",
    "timestamp": "2024-12-16T10:30:00Z",
    "data": {
        "order": {
            "id": "019b4139-1234-7abc-8def-123456789abc",
            "petId": "019b4132-70aa-764f-b315-e2803d882a24",
            "userId": "019b4138-e0af-70b9-8f0c-6ea97d495dfa",
            "status": "APPROVED",
            "totalAmount": "125.50",
            "currency": "USD",
            "createdAt": "2024-12-16T09:00:00Z",
            "updatedAt": "2024-12-16T10:30:00Z"
        },
        "previousStatus": "PLACED",
        "newStatus": "APPROVED",
        "changedAt": "2024-12-16T10:30:00Z",
        "changedBy": "system"
    }
}'

Responses

🟢200

Webhook received successfully

This response does not have a body.

🟠401

Modified at 2026-07-13 05:55:08

Get User

Payment Succeeded Event