@spree/docs 0.1.263 → 0.1.264
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -12,7 +12,7 @@ Webhooks are built on top of Spree's [event system](events.md), providing:
|
|
|
12
12
|
- **Multi-store support** - Each store has its own webhook endpoints
|
|
13
13
|
- **Event filtering** - Subscribe to specific events or patterns with wildcards
|
|
14
14
|
- **Secure delivery** - HMAC-SHA256 signatures for payload verification
|
|
15
|
-
- **Failure handling** - Failed deliveries are
|
|
15
|
+
- **Failure handling** - Failed deliveries are retried automatically and can be re-sent by hand, and an endpoint that keeps failing is disabled
|
|
16
16
|
- **Full audit trail** - Track every delivery attempt with response codes and timing
|
|
17
17
|
|
|
18
18
|
## How Webhooks Work
|
|
@@ -269,7 +269,9 @@ end
|
|
|
269
269
|
|
|
270
270
|
### Failed Deliveries
|
|
271
271
|
|
|
272
|
-
|
|
272
|
+
Any response other than 2xx — including a timeout or a connection error — marks the delivery as failed. Spree then sends it again, waiting longer before each try, up to 5 attempts in total over about six minutes. The delivery log shows the outcome of the latest attempt. Retries stop as soon as the endpoint is turned off.
|
|
273
|
+
|
|
274
|
+
Every attempt carries the same event `id`, so use it to ignore an event your receiver has already processed. To send a delivery again after the retries run out, re-send it from the delivery log (see below).
|
|
273
275
|
|
|
274
276
|
If an endpoint fails 15 deliveries in a row, Spree disables it and emails the store staff. Fix the endpoint, then turn it back on by marking it active again.
|
|
275
277
|
|
|
@@ -63,7 +63,7 @@ When the consumer is a system you do not deploy your own code into, use a webhoo
|
|
|
63
63
|
|
|
64
64
|
Each delivery is an HTTP POST carrying the event name and the same serialized payload. The endpoint's **signing secret is shown once when you create it**: store it in the receiving system and verify every request against it, so the receiver can prove the call came from your store.
|
|
65
65
|
|
|
66
|
-
|
|
66
|
+
Failed deliveries are retried with increasing delays, and the dashboard shows the delivery history per endpoint, which is where to look when a third party says they never received something.
|
|
67
67
|
|
|
68
68
|
> **TIP:** Webhooks need no code in your app at all. Reach for a subscriber only when the reaction needs application context or credentials you would rather not hand to a third party. See [events](../core-concepts/events.md) and [webhooks](../core-concepts/webhooks.md).
|
|
69
69
|
|