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

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
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