docs(webhooks): document the API contract - #421
Merged
mikewheeleer merged 2 commits intoJul 28, 2026
Conversation
The GET /api/v1/webhooks handler inlined the same limit/offset parsing and slicing preamble duplicated in the api-keys list handler. Extracted it into applyOffsetPage() in src/listPagination.ts as a single reusable entry point; behavior is unchanged (same defaults, same response shape).
Adds docs/webhooks.md covering list/get/create/patch/test/delete, the known event-type values, and an error-codes table.
Contributor
|
polished work @thlpkee20-wq, merging it in 🚀 |
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
2 participants
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.
Closes #380
Adds
docs/webhooks.mdcovering list (with the pagination contract),get-one, create, patch, test-delivery, and delete, the known event-type
values, and an error-codes table.
Test plan
npm run buildnpm run lint