Skip to content

Order status updated webhook
Webhook

Request

Triggered when an order status changes

Security
BearerAuth
Headers
x-hive-signaturestringrequired

HMAC-SHA256 signature of the request body using your API token as the key

Bodyapplication/json
event_typestringrequired

The type of webhook event

Value:"order.status_updated"
event_idstring, (uuid)required

Unique identifier for this webhook event

timestampstring, (date-time)required

When the event occurred

dataobject(OrderBase)required

Base Order schema shared by mutation responses (create/update/cancel) and webhook payloads. Read responses use Order, which extends this schema with has_blocking_issues.

Payload
{
  "event_type": "order.status_updated",
  "event_id": "123e4567-e89b-12d3-a456-426614174000",
  "timestamp": "2023-10-01T12:00:00Z",
  "data": {
    "id": 123456,
    "merchant_order_id": "ORD-1001",
    "sales_channel_id": 10,
    "fulfillment_status": "shipped",
    "financial_status": "paid",
    "created_at": "2023-10-01T12:00:00Z",
    "currency": "EUR",
    "total_price_in_cents": 3000,
    "total_net_refunds_in_cents": 0,
    "total_net_revenue_in_cents": 2430,
    "total_tax_in_cents": 570,
    "total_tax_refunds_in_cents": 0,
    "carrier_preference": "DHL",
    "updated_at": "2023-10-01T14:30:00Z",
    "items": [ … ],
    "shipping_address": { … }
  }
}

Responses

Webhook received successfully