v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Exception

Mint a callback credential

Mints an opaque bearer token bound to the caller's tenant for authenticating inbound external-system exception callbacks, and returns the raw token ONCE. Only the token's SHA-256 hash is stored server-side.

post/v1/exceptions/callbacks/credentials

Request body

externalSystemstring

Optional operator-legible label for the external system this credential authenticates (e.g. "stripe", "billing-gw")

Example request

{
  "externalSystem": "stripe"
}

Response

Created

createdAtstring required

Mint time (RFC 3339, UTC)

credentialIdstring uuid required

Surrogate id of the minted credential

externalSystemstring

Operator-legible external-system label, echoed for confirmation

tokenstring required

Raw bearer token, surfaced exactly once; configure it as the X-Callback-Token header value in the external system. Only its SHA-256 hash is stored server-side.

webhookUrlHintstring

Informational inbound-callback URL shape to configure in the external system. The {exceptionId} placeholder is filled per callback.