Support diagnostics
Every response includes a Carebit-Developer-Platform-API-Request-Id
header. Store it alongside your own log correlation IDs and include it
in every support ticket you open.
What to attach
For an API problem:
- The HTTP method and full URL, including query string.
- The
Carebit-Developer-Platform-API-Request-Idfrom the response. - The response status, response body, and response headers.
- The request headers you sent (redact
Authorization). - The
Idempotency-Key, if the endpoint is a create or update. - A minimal reproduction: the shortest request that reproduces the behavior.
For a webhook problem:
- The
Carebit-Delivery-IdandCarebit-Event-Idvalues from the request headers. - The event type and the endpoint id.
- The raw request body bytes (do NOT reformat the JSON) if you suspect a signature mismatch.
- Which secrets were active on the endpoint at the time of the delivery.
What we do not need
Do not paste customer PHI in a support ticket. Redact patient names and
identifiers, or share the Carebit-Developer-Platform-API-Request-Id
and event id and let Carebit look up the payload internally.
Status page
Follow the Carebit status page (opens in a new tab) for platform incidents. Individual delivery failures are visible in the developer dashboard.