Read the registry's default webhook endpoint

Authentication

AuthorizationBearer

Partner API key sent as Authorization: Bearer cfk_.... Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

Path parameters

refstringRequired

Response headers

X-Request-IdstringOptional

The ID of this request. On an error it equals request_id in the body. If you sent an X-Request-Id, it is your value, returned unchanged. Log it, and quote it when contacting CONFIRM support.

Response

The configured endpoint.

organization_refstringOptional

Your registry identifier, echoed back.

urlstringOptionalformat: "uri"

created_atdatetimeOptional

updated_atdatetimeOptional

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error