Repository navigation
docs(integration-platform): Fix signature verification and verify-install examples - #20303
Merged
mrduncan merged 1 commit intoOct 29, 2026
Merged
Conversation
…tall examples Verify signatures over the raw request body, document the Sentry-App-Signature header used by UI component requests, and add the missing Authorization header to the verify-installation request. Co-Authored-By: Matt Duncan <matt.duncan@sentry.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Contributor
|
Services awaiting deployment · Rollout details
Mention |
Christinarlong
approved these changes
Oct 29, 2026
mrduncan
deleted the
docs/integration-platform-signature-and-verify-fixes
branch
October 29, 2026 17:05
Contributor
|
Rollouts can't watch this change after it deploys: every data source for this team needs to be signed in again, so a check has no telemetry to read. Sign in to your data sources, or ask a team admin to. |
This branch was successfully deployed
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.
This fixes three problems in the Integration Platform docs. Each fix was checked against
getsentry/sentrysource.webhooks.mdx). Both snippets serialized the parsed body again before hashing it. Sentry signs the exact body it sends, which is compact JSON fromsentry.utils.json.dumpswith(",", ":")separators. Python's defaultjson.dumpsadds spaces, so its digest never matches. The Python snippet also passed astrtohmac.new, which raises aTypeError. Both snippets now verify against the raw body, and the JS one uses a constant-time comparison.Sentry-App-Signaturedocs (ui-components/index.mdx). UI component requests (select options, issue-link create and link, alert-rule-action) sendSentry-App-Signature, notSentry-Hook-Signature. See_build_headersinsrc/sentry/sentry_apps/external_requests/*_requester.py. The new "Verifying Requests" section documents that header and two related details:GETs with no body, signed over"".public-integration.mdx). ThePUTexample had noAuthorizationheader.SentryAppInstallationPermission(src/sentry/sentry_apps/api/bases/sentryapps.py) only allows this request from the app's own token, so the example as written fails.Checks
prettier --checkon the changed files.webhooks.mdxandui-components/index.mdxpass.public-integration.mdxwas already failing onmaster(tabs in the JWT snippet), and this PR leaves that as is.IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST
via matt.duncan.
--
View Junior Session [Sentry]