Added string[] to WebhookHeader type for compatibility with express#2652
Merged
prathmesh-stripe merged 2 commits intomasterfrom Apr 3, 2026
Merged
Conversation
xavdid
approved these changes
Apr 3, 2026
Member
xavdid
left a comment
There was a problem hiding this comment.
fix looks good, but you should add a line to the types test to we catch this sort of thing in the future!
There was a problem hiding this comment.
Pull request overview
This PR updates the webhook header typing and related internal parsing/validation to be compatible with Express/Node header types, addressing the string | string[] header scenario raised in issue #2651.
Changes:
- Expanded
WebhookHeaderto includestring[]for Express compatibility. - Moved the “array header” guard earlier in
parseEventDetailsto fail fast. - Tightened internal
WebhookParsedEventandvalidateComputedSignaturetypes to reflect decoded string values.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
string[] to WebhookHeader type for compatibility with express
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.
Why?
In the most resent release we got rid of the manually maintained type for constructEvent in Webhook.d.ts.
This caused a problem with express framework. Express's type for
Request#headersisstring | []string. Although signature would never bestring[], we still need to handle it.What?
string[]to WebhookHeader type.parseEventDetailsto throw an error early.validateComputedSignaturemethod to accommodate the change in type of WebhookHeader.See Also
#2651
Changelog
string[]to the type ofsignatureparam instripe.webhooks.construct_eventmethod.