Webhook events
Events
Every webhook delivery and every item in GET /v1/events is an event: a small envelope around the object that changed, exactly as the API returns it. Read Receiving webhooks for delivery and retries, and Verifying signatures before you trust a payload.
The event object
- idstringRequired
Unique per event. Deliveries can repeat — ignore an id you've already processed.
starts with evt_
- objectstringRequired
always "event"
- typestringRequired
- api_versionstringRequired
always "v1"
- created_atstringRequired
ISO 8601 date-time, UTC
- livemodebooleanRequired
- store_idstring
- dataobjectRequired
2 child fields
- objectobject
The object as it was when the change was saved.
- previous_attributesobject
The fields that changed and their old values, when known.
- requestobject
1 child field
- api_key_idstring or null
The API key that caused the change, if any.
Example
{
"id": "evt_1a2b3c4d5e6f40718293a4b5c6d7e8f9",
"object": "event",
"type": "order.status_changed",
"api_version": "v1",
"created_at": "2026-10-11T10:05:00Z",
"livemode": true,
"store_id": "sto_52cac290122d489091f64df771b29e1a",
"data": {
"object": {
"id": "ord_9b1c2d3e4f5a4b6c8d7e6f5a4b3c2d1e",
"object": "order",
"status": "confirmed"
},
"previous_attributes": {
"status": "pending"
}
},
"request": {
"api_key_id": "key_dabefb2303b6496999008c7c863f6733"
}
}All events
| Event | Sent when |
|---|---|
order.created | An order is created |
order.updated | An order changes |
order.status_changed | An order's status changes |
order.cancelled | An order is cancelled |
order.needs_review | An order needs the merchant to confirm its address |
order.note_added | A note is added to an order |
product.created | A product is created |
product.updated | A product or one of its variants changes |
product.deleted | A product is archived or deleted |
inventory.updated | A variant's stock changes |
customer.created | A customer is created |
customer.updated | A customer's name, contact, status, tags or note changes |
shipment.created | An order is sent to a courier |
shipment.updated | A shipment's tracking changes |
abandoned_checkout.created | A shopper leaves their details at checkout |
abandoned_checkout.updated | An abandoned checkout changes |
review.created | A review is submitted or added |
bulk_job.completed | A bulk job finished |
ping | A test event is requested |
