Skip to content

Return status updated webhook
Webhook

Request

Triggered when a return status changes

Security
BearerAuth
Headers
x-hive-signaturestringrequired

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

Example:a1b2c3d4e5f6...
Bodyapplication/json
event_typestringrequired

The type of webhook event

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

Unique identifier for this webhook event

timestampstring, (date-time)required

When the event occurred

dataobject(Return)required
Example:
{
  "id": 5555,
  "announced_items": [
    { … }
  ],
  "carrier": "DHL",
  "completed_handling_at": "2023-10-10T15:00:00Z",
  "created_at": "2023-10-08T10:00:00Z",
  "handled_items": [
    { … }
  ],
  "order": {
    "id": 123456,
    "merchant_order_id": "ORD-1001",
    "customer_order_number": "CUST-ORD-2023-01"
  },
  "photos": [
    { … }
  ],
  "received_at": "2023-10-09T12:00:00Z",
  "return_reason": "customer_return",
  "return_reason_type": "active",
  "started_processing_at": "2023-10-09T13:00:00Z",
  "status": "arrived",
  "tracking_code": "TRACK-RET-123",
  "tracking_url": "https://dhl.com/track/RET-123",
  "updated_at": "2023-10-10T15:00:00Z"
}
POST
return.status_updated
Payload
{
  "event_type": "return.status_updated",
  "event_id": "123e4567-e89b-12d3-a456-426614174002",
  "timestamp": "2023-10-01T18:00:00Z",
  "data": {
    "id": 5555,
    "status": "arrived",
    "created_at": "2023-10-01T18:00:00Z",
    "updated_at": "2023-10-01T18:00:00Z",
    "announced_items": [ … ],
    "order": { … }
  }
}

Responses

Webhook received successfully