Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

How to handle webhook versioning? #165

Open
cucho opened this issue Jun 27, 2024 · 2 comments
Open

How to handle webhook versioning? #165

cucho opened this issue Jun 27, 2024 · 2 comments

Comments

@cucho
Copy link

cucho commented Jun 27, 2024

How do the producers communicate to the consumers what version they are using? For example, if the payload shape has a breaking change (removes a field), where does the producer bump the version?
@jacobzim-stl
Copy link

jacobzim-stl commented Aug 14, 2024 •
edited
Loading

My instinct is that you"d use additional metadata inside the payload to implement this in an application dependent manner. I"d like if an explicit recommendation (or an explicit justification for its omission), could be added to the "Operational Considerations" section though.

@svix-ken
Copy link

We just published a blog post on this topic: https://www.svix.com/blog/webhook-versioning/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@cucho @svix-ken @jacobzim-stl