Set the registry's default webhook endpoint
Sets (or replaces) the fallback delivery target for this registry.
It is used for any applicant that has no webhook_url of their own —
in practice, everyone CONFIRM sourced. Applicants you sent us keep using
the URL you supplied with them; this never overrides that.
Idempotent: sending the same URL twice returns the same record. There is exactly one endpoint per registry, so there is no endpoint ID for you to store.
The URL is held to the same rules as a per-applicant webhook_url:
HTTPS, a public host that exists in DNS, no embedded credentials, 2048
characters at most. A URL that breaks a rule returns 400 with one of
the codes in the
webhooks guide:
invalid_webhook_url, webhook_url_not_https,
webhook_url_forbidden_host, webhook_url_too_long, or
webhook_url_unresolvable.
Authentication
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
Your registry identifier (the external_ref you created it with).
Request
Response headers
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
Default endpoint created. Sending again for a registry that already has one returns 200 and replaces the URL.