fc.rubix.sdk.webhook.retry.method
Setting
Changed on:
5 Nov 2026
| Setting Area | Workflow |
|---|---|
| Supported context levels: | WORKFLOW (RETAILER) |
Overview
This workflow setting controls which rule a failed webhook is retried with.With`preserve-event-details`, the retry reruns the rule that produced the webhook action, so the retry applies the same logic as the original call. Without the setting, the retry is sent by the built-in platform webhook rule to the same endpoint.Values
| Data Type | Values |
|---|---|
| STRING | Default Value(s):
|
Detailed technical description
Webhook Retry Rule
To ensure full backward compatibility, this setting toggles between the following:- Default behavior:
A failed webhook is retried by the built-in platform rule`FLUENTRETAIL.base.SendWebhook`, which posts the retry event to the endpoint of the failed webhook. The retry event is built from the event that`fc.rubix.webhook.retry.event`selects. The logic of the rule that produced the webhook action, for example a custom payload, isn’t applied to the retry. This is valid under the following conditions:- The
`fc.rubix.sdk.webhook.retry.method`setting is not added to the workflow - The
`fc.rubix.sdk.webhook.retry.method`setting is added with any other value
- The
- Custom webhook rule logic:
A failed webhook is retried by rerunning the rule that produced the webhook action, with the same props, so the retry applies the same logic as the original call. This is valid under the following conditions:- The
`fc.rubix.sdk.webhook.retry.method`setting is added to the workflow with the`preserve-event-details`value
- The
Scope
- The setting changes only the rule a webhook is retried with
- The retry schedule is set by
`fc.rubix.sdk.webhook.retry.schedule` - A retry runs only this one rule. The other rules of the ruleset in which the webhook action was produced aren’t run again
- With
`preserve-event-details`, the whole rule runs again on every retry:- Its mutations and scheduled events are repeated, and so are any other webhooks it sends
- Its payload is built from the current state of the entity, not from its state at the time of the original call
- The event the rule is rerun on is set by
`fc.rubix.webhook.retry.event`:- With
`webhook-event`, the rule is rerun on the webhook event - With
`initial-event`, the rule is rerun on the initial event of the event context
- With
Explanation through an Example
The`NotifyErp` ruleset of an Order contains a custom `SendOrderToErp` rule that builds its own payload and posts it with the `postWebhook` action. The webhook action fails with a connection timeout:- Without the setting: the retry is sent by
`FLUENTRETAIL.base.SendWebhook`to the same endpoint, with the event instead of the payload built by`SendOrderToErp` - With
`preserve-event-details`:`SendOrderToErp`is rerun with its props, builds its payload again, and posts it to the endpoint - If
`SendOrderToErp`also updates an Order attribute with a mutation, for example`sentToErp`, the mutation runs again on every retry
Configuration example
1"settings": {
2 "fc.rubix.sdk.webhook.retry.method": "preserve-event-details"
3}