Document the Webhook-Id delivery header - #2749
Open
Kakulukian wants to merge 2 commits into
Open
Conversation
Webhook deliveries now include a `Webhook-Id` HTTP header (and a `WEBHOOK_ID` env var for Job webhooks) that is stable across retries of a delivery, so consumers can dedupe and process events idempotently. Also note that replays reuse the original delivery's id. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Kakulukian
marked this pull request as ready for review
August 31, 2026 13:29
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
2 participants
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.
Webhook deliveries now include a
Webhook-IdHTTP header (and aWEBHOOK_IDenv var for Job webhooks) that is stable across retries of a delivery, so consumers can dedupe and process events idempotently. Also note that replays reuse the original delivery's id.Note
Low Risk
Documentation-only updates describing existing webhook delivery behavior; no code or runtime changes.
Overview
Documents how Hub webhook consumers can dedupe deliveries using a stable per-delivery identifier.
In
webhooks.md, the Delivery and retries section now explains theWebhook-IdHTTP header: each delivery gets a unique ID, retries reuse it (usable as an idempotency key). The Debugging section adds that replays send the sameWebhook-Idas the original delivery.In
jobs-webhooks.md, the Job webhook env var list addsWEBHOOK_IDwith the same stability-across-retries behavior for Job-triggered webhooks.Reviewed by Cursor Bugbot for commit 459ad64. Bugbot is set up for automated code reviews on this repo. Configure here.