Rules & rulesets overview
A rule is a piece of instructional logic that dictates the behavior of events routed through a connection. A ruleset is a group of rules that can be reused across many connections.
How rules work
Every connection in Hookdeck must have a ruleset, and these rulesets can be shared across many connections. Each workspace begins with Hookdeck's default ruleset, which can be tweaked to fit your team's needs.
Override specific rules by applying custom rules directly to a connection.
Rule types
Five types of rules are available in Hookdeck: retry, alert, delay, filter, and transformation.
Retry rule
The retry rule determines the rate and limit of automatic retries on failed events.
| Retry Rule Element | Explanation |
|---|---|
| Strategy | A linear strategy means retries will occur at regular intervals; an exponential strategy means each retry will be delayed twice as long as the previous (1 hour, 2 hours, 4 hours...) |
| Interval | The delay between each automatic retry |
| Count | The number of automatic retries Hookdeck will attempt after an event fails |
Automatic retries max out after one week, or 50 attempts – whichever comes first. Events can be manually retried after exceeding this limit.
Alert rule
The alert rule determines when Hookdeck will trigger new issues for failed events.
| Alert Strategy | Behavior |
|---|---|
| First Attempt Failure | Opens an issue as soon as an attempt fails |
| Final Attempt Failure | Opens an issue when the maximum retry count is reached, and all previous attempts have failed |
Delay rule
The delay rule allows you to introduce a delay between the moment Hookdeck receives an event, and when it's forwarded to your destination.
Filter rule
The filter rule allows you to route webhooks differently based on the contents of their Headers, Body, Query, and/or Path.
For more information on how to set up filters, see our filter documentation.
Transformation rule
The transformation rule allows you to modify the payload of a webhook before it gets delivered to a destination.
For more information on how to set up transformations, see our transformation documentation.