Saltar al contenido
DocsBuild with Runner
Esc
↑↓navegar↵abrir⌘Jvista previa
Open Runner

Store events, sent to your service

The webhook events a Runner store sends, the envelope of each delivery, and how to check that Runner sent it.

Every delivery is a signed POST request with a JSON body. Subscribe a destination to all events, or only to the events that it needs. To set up a destination, read Webhooks.

  • Payload version: apiVersion 2026-04.
  • Signature headers: svix-id, svix-timestamp, and svix-signature.
  • Money is a whole number in the smallest unit of the currency: 1250 in USD is $12.50.

Events

Each event puts its fields in data. A field marked optional can be missing from a delivery. The Event catalog tab in Webhooks shows the full schema and an example for each event type.

Events with a full payload

Event When it is sent Fields in data
marketing_email.subscribed A shopper joins the store’s marketing email list, or subscribes again after unsubscribing. subscriptionId, email, consentedAt, consentSource (storefront_newsletter, storefront_checkout, or storefront_account_registration)
order.placed A shopper places an order. id, displayId, currency, total, subtotal, email, placedAt, items; optional orderNumber, cartId, customer, shippingAddress, billingAddress, breakdown, confirmation (now, deferred, or off)
order.canceled An order is canceled. id, displayId, currency, total, canceledAt; optional reason, refundAmount
order.shipped A fulfillment for an order is shipped. carrier and trackingNumber are empty strings when they are not known. orderId, displayId, shippedAt, carrier, trackingNumber; optional trackingUrl, estimatedDeliveryAt, customer
order.delivered The carrier reports that an order was delivered. orderId, deliveredAt; optional displayId, carrier, trackingNumber, customer
delivery.created The store records a delivery for a fulfillment. fulfillmentId, orderId, deliveredAt; optional carrier, trackingNumber
payment.refunded A payment is refunded, in full or in part. orderId, paymentId, refundId, amount, currency, refundType, refundedAt
return.received The store receives a returned item. returnId, orderId, status, receivedAt, items
cart.created A shopper starts a cart. id, currency, total, subtotal, email, items; optional customer, updatedAt
cart.updated A shopper changes a cart. id, currency, total, subtotal, email, items; optional customer, updatedAt
cart.abandoned A cart stays idle past the store’s abandonment window. cartId, lastActivityAt, items, total; optional checkoutUrl, currency, customer
customer.created A customer record is created, including guest checkouts and imported customers. id, email, createdAt, hasAccount; optional firstName, lastName
customer.deleted A customer record is deleted. id, email, deletedAt
review.posted A shopper posts a product review. reviewId, productId, rating, postedAt; optional productTitle, title, body, customer
booking.confirmed A booking is confirmed. bookingId, serviceTitle, startTime, endTime, timezone, customer; optional videoLink, videoProvider

Change notices

These events tell your service that a record changed. Their data holds the record ID and occurredAt. Read the full record from the store if you need more.

Events Fields in data
product.created, product.updated, product.deleted, product-variant.created, product-variant.updated, product-variant.deleted, product-option.created, product-option.updated, product-option.deleted, product-category.created, product-category.updated, product-category.deleted, product-collection.created, product-collection.updated, product-collection.deleted, product-tag.created, product-tag.updated, product-tag.deleted, product-type.created, product-type.updated, product-type.deleted id, occurredAt
inventory-item.created, inventory-item.updated, inventory-item.deleted id, occurredAt
inventory-level.created, inventory-level.updated, inventory-level.deleted, reservation-item.created, reservation-item.updated, reservation-item.deleted id, occurredAt; optional orderId
order.updated, order.completed, order.archived id, occurredAt
order.transfer_requested id, orderChangeId, occurredAt
order-edit.requested, order-edit.confirmed, order-edit.canceled orderId, occurredAt
order.fulfillment_created, order.fulfillment_canceled orderId, fulfillmentId, occurredAt; optional noNotification
order.return_requested orderId, returnId, occurredAt
order.claim_created orderId, claimId, occurredAt
order.exchange_created orderId, exchangeId, occurredAt
payment.captured id, occurredAt
cart.customer_updated, cart.region_updated id, occurredAt
cart.customer_transferred id, customerId, occurredAt
customer.updated id, occurredAt
auth.password_reset entityId, actorType, occurredAt
auth.verification_requested entityId, actorType, provider, occurredAt; optional expiresAt
shipping-option.created, shipping-option.updated, shipping-option.deleted, shipping-option-type.created, shipping-option-type.updated, shipping-option-type.deleted id, occurredAt
region.created, region.updated, region.deleted, sales-channel.created, sales-channel.updated, sales-channel.deleted, translation.created, translation.updated, translation.deleted id, occurredAt
user.created, user.updated, user.deleted, invite.created, invite.accepted, invite.resent, invite.deleted id, occurredAt

The envelope

Every event has the same envelope:

Field What it holds
type The event type, for example order.placed.
apiVersion The payload version, currently 2026-04.
eventId A unique ID for this event. Use it to skip a delivery that you already handled.
timestamp When the event happened, as an ISO 8601 date and time.
source Optional. Where the event came from, for example { "kind": "audit-fact", "provider": "runner" }. Most store events do not have it.
data The event payload. Events lists its fields.

This order.placed delivery is an example; … marks a value that is different in each delivery.

{
  "type": "order.placed",
  "apiVersion": "2026-04",
  "eventId": "…",
  "timestamp": "2026-11-16T09:12:04Z",
  "data": {
    "id": "…",
    "displayId": 1042,
    "currency": "…",
    "total": 1250,
    "subtotal": 1000,
    "email": "…",
    "placedAt": "2026-11-16T09:12:03Z",
    "items": []
  }
}

Check that Runner sent it

The headers svix-id, svix-timestamp, and svix-signature let your service verify that Runner sent the event. Keep the endpoint address and the signing secret private. If a signing value is exposed, replace it in Runner and in your service before you send more events.

Última actualización el 19 de noviembre de 2026

¿Te ha resultado útil esta página?