20608 - Compatibility API: clarify StatusCallbackEvent surfaces terminal failed events - #631
Open
Mikeysax wants to merge 1 commit into
Open
20608 - Compatibility API: clarify StatusCallbackEvent surfaces terminal failed events#631Mikeysax wants to merge 1 commit into
Mikeysax wants to merge 1 commit into
Conversation
… failed events Updates the description of the StatusCallbackEvent parameter for the Calls API to document the new behavior from prime-rails#9876 (cloud-product#20528): subscribing to completed now also surfaces a final status: failed webhook when the call is blocked by Musubi (with ErrorCode 20429), the DNO registry, no-registered-endpoints, or a temporary error. The new callbacks are additive; no action is required for existing integrations. Refs cloud-product#20608 (workstream 1, public API docs). Refs cloud-product#20528 (the underlying behavior gap). Refs prime-rails#9876 (the code PR).
Contributor
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.
What
Updates the OpenAPI description of the
StatusCallbackEventparameter for the Calls API to document the new behavior from prime-rails#9876 (cloud-product#20528):Subscribing to
completednow also surfaces a finalstatus: failedwebhook when the call is blocked by:ErrorCode 20429)The new callbacks are additive — no action is required for existing integrations. Documentation-only change; no schema impact.
Diff
fern/apis/compatibility/openapi.yaml— single-line update to theStatusCallbackEventparameter description. One sentence appended clarifying the new behavior.Why
Per CONTRIBUTING.md and the rollout runbook on cloud-product#20400, customer-facing behavior changes require public API docs updates before merge. PR #9876 introduces this new callback behavior; the OpenAPI spec currently doesn't reflect it.
Cross-references
Review focus
fern/products/compatibility-api/pages/cxml/voice/MDX content)? If MDX content also needs updating, file a follow-up.Deploy notes
main.Ready for review — reviewers requested
Per CONTRIBUTING.md this is one of the gating artifacts for merging prime-rails#9876. The wording is grounded in shipped code; iterate freely in review. The customer-facing changelog entry (workstream 3 of #20608) should align with this wording — but the changelog lives in the release-notes channel and can be tweaked at any point, so no need to gate this PR on it.