Partner APIWebhooks

Create an organization webhook endpoint

Registers a webhook endpoint that receives events for this organization only. Subscribe to specific event types or `["*"]` for all. The response includes the signing `secret` (`cfwh_...`) — it is shown **once**; store it securely. Deliveries are signed with `Confirm-Signature` (HMAC-SHA256, see the API introduction).

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

org_idstringRequired

Organization ID (org_...).

Headers

Idempotency-KeystringOptional<=255 characters

Unique key (e.g. a UUID) making this POST safe to retry. Replays within 24 hours return the original response without repeating side effects.

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"
HTTPS URL deliveries are POSTed to.
eventslist of stringsRequired

Event types to subscribe to, or ["*"] for all.

descriptionstring or nullOptional

Response

Webhook endpoint created; secret is shown only in this response.

idstringOptional

Webhook endpoint ID (whk_...).

org_idstring or nullOptional

Owning organization, or null for a partner-level endpoint receiving events for all organizations.

urlstringOptionalformat: "uri"
eventslist of stringsOptional

Subscribed event types, or ["*"].

descriptionstring or nullOptional
secretstring or nullOptional

Signing secret (cfwh_...) used for the Confirm-Signature HMAC-SHA256 header. Returned only in the create response; null everywhere else.

created_atdatetimeOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error