Skip to content

Add error messages to help users debug signature verification failures - #1958

Open
orrc wants to merge 1 commit into
masterfrom
orrc/tse-2678-signature-debug-metadata
Open

orrc wants to merge 1 commit into
masterfrom
orrc/tse-2678-signature-debug-metadata

Conversation

@orrc

@orrc orrc commented Oct 29, 2026

Copy link
Copy Markdown
Member

Why?

Webhook signature verification failures are often caused by using the wrong signing secret, or modifying the payload before passing it into the verification function. However, we're currently unable to provide developers with any hints as to why verification is failing.

What?

The stripe-signature HTTP header sent with each event will start to include metadata about the event destination and the event payload.

This update uses that metadata, when present, to provide more detailed error messages in the case of signature verification failures. These can help developers narrow down what might be wrong with their code or configuration.

No changes are made to the actual signature verification process; this just updates how error messages are generated.

See Also

https://go/j/TSE-2678
https://go/j/SECREV-5921

Configuration

  • skip-changefile: This PR is not a user-facing change, so there's no changefile.

The stripe-signature header may now include additional metadata about
the event destination and the event being sent. These can help narrow
down the reason why signature verification failed.

No changes are made to the verification process; this just updates how
error messages are generated, if the metadata is present in the header.
@orrc
orrc requested a review from a team as a code owner October 29, 2026 21:15
@orrc
orrc requested review from mark-kogan-stripe and removed request for a team October 29, 2026 21:15

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant