Callback and Event Catalog
In Short
Partner callbacks are signed JSON events posted to POST /v1/callbacks/partner/{partner_key}.
Event names are integration-specific strings — design for idempotency, include correlation metadata, and link
operational routing to the launch and partner-switch operations in ReDoc.
Routing Operations (Cross-Reference)
| Operation | Purpose | ReDoc |
|---|---|---|
postLaunchPartnerSubset |
Start governed launch from partner UI | Partner API |
postPartnerSwitchPartnerSubset |
Switch active partner context | Partner API |
postPartnerCallback |
Inbound signed callback from partner | Partner API |
Callback Event Patterns
Event strings are not a closed enum in the partner subset contract — agree names during onboarding. Common patterns:
| Event pattern | Purpose | Idempotency / correlation |
|---|---|---|
launch_complete |
Partner reports launch handoff completion | Include X-Correlation-Id; safe to dedupe by event + business key |
partner.report.ready |
Partner artifact or report ready for downstream routing | Include run_id and correlation_id in payload when applicable |
Signing: HMAC-SHA256 over {tenant_id, partner_key, payload}. See Launch and Callback.
Retry and Failure Posture
400/PARTNER_CALLBACK_INVALID— fix signature or payload; do not retry blindly503— processing unavailable; bounded retry with backoff- Always send
X-Correlation-Idwhen available for support correlation