fix(docs): correct webhook payload shape, events, paths, and retries#41
Merged
Conversation
- Delivered body is the versioned envelope (job fields under `data`), not flat. - Full event catalog (job.started not job.running; all 7 events). - Retry policy: 5 attempts with exponential backoff (was "3 / 5-25-125s"). - Verify example uses verifyWebhook(rawBody, headers, secret). - Fix endpoint paths: /webhooks/endpoints (was /webhook-endpoints) and GET /webhooks/deliveries?endpointId= (was a path segment).
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
1 participant
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.
Corrects webhooks.mdx + sdk.mdx to match the shipped API: enveloped payload (fields under
data), the real 7-event catalog (job.started not job.running), 5-retry backoff,verifyWebhookusage, and the real endpoint paths (/webhooks/endpoints,/webhooks/deliveries?endpointId=). The old paths returned 404 — caught by the new webhook E2E.