API Design · Middle · Question 75 of 75

How should webhook payloads be versioned?

1Change them without notice
✓Correct answer: Include an event type and version (or API version) in each event, and let subscribers choose or migrate versions
3Never change webhook payloads

Explanation

Webhook consumers are API clients too; breaking changes in event shapes need the same care as endpoint changes.

Further reading

Test yourself

Take the API Design · Middle quiz: questions and options are shuffled, and you get a review of your mistakes at the end.