docs: comprehensive outbound webhooks doc with sync/async response contract#408
Open
jirwin wants to merge 2 commits into
Open
docs: comprehensive outbound webhooks doc with sync/async response contract#408jirwin wants to merge 2 commits into
jirwin wants to merge 2 commits into
Conversation
…ntract Rewrite the webhooks page to document how receivers respond to outbound webhooks: - Explain the synchronous (2xx + response document) vs asynchronous (202 + callback URL) response contract, and fix the confusing callback guidance (the receiver returns 202 to opt into async mode; a blank callback POST is not valid) - Document all response formats per event type, including provisioning complete/errored and policy replacePolicy - Add all live event types (approval step, automation step) - Add request headers, webhook URL requirements, delivery retry and failure behavior, and the configurable callback timeout (1-30 days) - Correct JWT claim details (aud hostname, 2-minute token lifetime) Co-authored-by: c1-squire-dev[bot] <c1-squire-dev[bot]@users.noreply.github.com> Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Co-authored-by: c1-squire-dev[bot] <c1-squire-dev[bot]@users.noreply.github.com> Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
jirwin
marked this pull request as ready for review
July 21, 2026 14:49
Author
|
This has been reviewed and approved for technical accuracy |
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.
Summary
Rewrites
product/admin/webhooks.mdxinto a comprehensive reference for outbound webhooks, verified against current product behavior.What changed
complete/errored, policyapprove/deny/reassign/replacePolicy, automationcontext, and test. The provisioning outcomes andreplacePolicywere previously undocumented.PayloadPolicyApprovalStepandPayloadWorkflowStep(previously only test and provision step were listed).Content-Digest,Webhook-Id/-Event/-Version/-Callback-Url), webhook URL requirements (HTTPS on 443, no credentials, public addresses only), and clarified thatcallbackUrlis present in every request.aud(destination hostname), token lifetime (2 minutes),nbfskew allowance, and listed supported signing algorithms.Notes for reviewers
PayloadPolicyPostActionexists in the API surface but I couldn't confirm it fires in production, so it's intentionally omitted — please confirm.complete/erroredare documented as the schema contract for reporting provisioning outcomes without promising distinct downstream behavior.docs-writingstyle skill;mint broken-linksis clean for this page (the 10 reported breaks are pre-existing in other files).🤖 Generated with Claude Code