Webhook Events

Order Item Status Change Webhook

Sent when an order item changes status. The payload includes the recipient, order, and order item context for the affected mail piece.

postWebhookorderItemStatusUpdate

Payload

event_typestring required
event_idstring required
timestampinteger required
date_timestring required

Example payload

{
  "event_type": "order_item.status_update",
  "event_id": "7199e4e0-516b-11f0-ba5f-f135ea42fb62",
  "data": {
    "order_item.id": 2668662,
    "recipient.name": "John Doe",
    "recipient.address": "123 Fake St",
    "recipient.city": "Any Town",
    "recipient.province": "NY",
    "recipient.postal_code": "12345",
    "recipient.country": "US",
    "recipient.custom_1": "Example Custom 1",
    "recipient.custom_2": "Example Custom 2",
    "recipient.custom_3": "Example Custom 3",
    "recipient.custom_4": "Example Custom 4",
    "recipient.custom_5": "Example Custom 5",
    "recipient.custom_6": "Example Custom 6",
    "recipient.custom_7": "Example Custom 7",
    "recipient.custom_8": "Example Custom 8",
    "recipient.custom_9": "Example Custom 9",
    "recipient.custom_10": "Example Custom 10",
    "order.id": 42399,
    "order.sub_account_id": 5,
    "order.status": "Printing",
    "order_item.delivery_date": "2025-07-05",
    "order_item.current_status": "Processing",
    "qrcode.url": "https://www.google.com",
    "order.metadata": {
      "crm_deal_id": "D-1042"
    }
  },
  "timestamp": 1750818235,
  "date_time": "2025-06-25 02:23:55"
}

Response

Webhook received

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.