Skip to content

Shipment delivery status updated webhook
Webhook

Request

Triggered when a shipment delivery 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

Enum:"shipment.status_updated""shipment.delivery_status_updated"
event_idstring, (uuid)required

Unique identifier for this webhook event

timestampstring, (date-time)required

When the event occurred

dataobject(ShipmentBase)required

Base Shipment schema used by webhook payloads. Read responses use Shipment, which extends this schema with the proof-of-delivery fields.

Payload
{
  "event_type": "shipment.status_updated",
  "event_id": "123e4567-e89b-12d3-a456-426614174001",
  "timestamp": "2023-10-01T15:00:00Z",
  "data": {
    "id": 789012,
    "order_id": 123456,
    "sales_channel_id": 10,
    "status": "shipped",
    "items": [ … ]
  }
}

Responses

Webhook received successfully