{
  "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"
  }
}

Webhooks

Order status changed event

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.

WEBHOOK

orderStatusChanged

{
  "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"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication using JWT (JSON Web Token). Include the token in the Authorization header as: Authorization: Bearer <token>

Body

application/json

eventId

string<uuid>

required

Unique identifier for this webhook event

Example:

"evt_9f4a8b3c-2d5e-6f7g-8h9i-0j1k2l3m4n5o"

eventType

string

required

Type of event

Allowed value: "order.statusChanged"

timestamp

string<date-time>

required

When the event occurred (RFC 3339)

data

object

required

Show child attributes

Response

Webhook received successfully

Create Token (Login)Payment succeeded event