Skip to main content

Fulfillment

Webhooks​

The following webhook events are available for this resource. See Webhooks for how delivery, retries, and versioning work.

EventDescriptionReflowExpandable
fulfillment_holdFired when an order is held for review——
fulfillment_transmitFired to transmit an order to the fulfillment house——

Receiving these events​

  • Payload: each delivery is a POST whose JSON body is an array of events, even when it carries one. Each element has a single key, the event name, whose value is the object, for example [{"fulfillment_hold": {...}}].
  • Contents: the object includes only the parts in the webhook's expansion. Expansions appear when you edit the webhook after creating it.
  • Respond within 30 seconds. Store or queue the payload and do the work in a background job.
  • Batching: one delivery can bundle several events. The webhook sets how many (10 or more) and the maximum payload size (up to 900K).
  • HTTPS: use it. It is required whenever the payload includes customer information.
  • Testing: the webhook's test button sends a delivery, and its log shows each one. To resend existing records, for example to backfill a new receiver, request a reflow.

More: Webhooks, Creating a simple webhook (with a sample payload), receiver samples in PHP and Python

Was this page helpful?