Repository navigation
docs(webhooks): publish the model webhook Events API reference - #39
Merged
Merged
Conversation
- Publish api-reference/webhooks.md and link it from the API reference
sidebar; the old guards dated from Sandbox event webhooks, which were
retired in B-225 (webhooks are model-only now).
- Document Bearer or X-API-Key auth and the {code,message} error body.
- Add /events/webhooks list/create/update/delete to the OpenAPI spec with
a WebhookApiKey scheme; the endpoints never apply spending limits.
- Validators now require the page, sidebar link and OpenAPI paths.
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.
Publishes the webhook management reference, which was previously excluded from the build because webhooks used to carry Sandbox events. Since B-225 they are model-only.
X-API-Key(Bearer wins),{code,message}error body, 400/401/404, and list/patch/delete response shapes./events/webhooksGET/POST and/events/webhooks/{webhook_id}PATCH/DELETE, plusWebhook*schemas and aWebhookApiKeyscheme. Checked againstcmd/server/webhooks.go,handler/org_webhook.goandhandler/webhook_management.go: create returns 200, list returns a bare array, delete returns 204, and no spending-limit check is applied.Tested:
npm run validatepasses (1553 HTML pages).