Repository navigation
Import an existing signing secret when creating an outbound endpoint - #3
Merged
Merged
Conversation
endpoints.create accepts an optional secret (whsec_ + base64 of a 24-64 byte key, e.g. exported from Svix), so migrated consumers keep verifying with the key they already have. The API has accepted it since backend PR #1093.
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.
Adds
secrettorelay.outbound.endpoints.createparams (newOutboundEndpointCreateParams), so a migration from Svix or another Standard Webhooks sender can import each endpoint's existingwhsec_secret and customers keep verifying with it. The API has acceptedsecreton endpoint create since rusenask/webhookrelay#1093.🤖 Generated with Claude Code
Note
Low Risk
Optional SDK typing and docs for an already-supported API field; no change to default create behavior when
secretis omitted.Overview
Adds optional
secretonrelay.outbound.endpoints.createvia newOutboundEndpointCreateParams, so migrations from Svix or other Standard Webhooks senders can register an endpoint with an existingwhsec_key instead of forcing a new signing secret.The create helper still uses
outboundEndpointParams; whensecretis set it is sent on the POST body (covered by a new test). README and JSDoc call out the migration path.Reviewed by Cursor Bugbot for commit d276b20. Configure here.