Repository navigation
[RUN-5116] Document webhook trigger rate limiting - #2039
Open
Jesus-Osuna-M wants to merge 2 commits into
Open
Jesus-Osuna-M wants to merge 2 commits into
Jesus-Osuna-M wants to merge 2 commits into
Conversation
Webhook triggers share one ceiling, separate from the API token rate. Document the property, the include class, and that the limit stays off until both are set. Co-authored-by: Cursor <cursoragent@cursor.com>
State the shared ceiling, the three settings that turn it on, and the 429 response. Co-authored-by: Cursor <cursoragent@cursor.com>
Jesus-Osuna-M
marked this pull request as ready for review
November 6, 2026 15:10
Jesus-Osuna-M
requested review from
a team
and
a balanced review from Copilot
November 6, 2026 15:10
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The configuration block at docs/administration/security/ratelimiting.md:93 lacks the properties language tag required by the documentation style guide.
1 open issue
What changed in this PR
This PR documents webhook trigger rate limiting in the Rundeck administration guide and links to it from the webhooks manual.
Changes:
- Adds the webhook limiter to the supported algorithms and explains its shared bucket, activation requirements, and HTTP 429 responses.
- Provides configuration guidance, marking
30as an example rather than a default. - Adds a cross-reference from the webhooks manual.
| File | Description |
|---|---|
docs/manual/webhooks.md |
Adds a request-limit summary and link to configuration guidance. |
docs/administration/security/ratelimiting.md |
Documents the webhook limiter’s configuration, behavior, and example settings. |
Review effort: Balanced
|
|
||
| The limiter stays off until `rundeck.apiRateLimiting.enabled=true`, `include` lists `rundeckpro.security.rateLimit.WebhookTokenApiRateLimiter`, and `rundeck.apiRateLimiting.webhook.rate` is a positive integer. Unset or `0` means no webhook limit. The window is `rundeck.apiRateLimiting.refillWindowInSeconds`. Over the limit the response is HTTP 429 with `Retry-After`. | ||
|
|
||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the webhook trigger rate limit. All tokens share
rundeck.apiRateLimiting.webhook.rate. It stays off until that value is a positive integer andWebhookTokenApiRateLimiteris ininclude.Test plan
30as an example, not a default