Overview
Clarion delivers all webhooks for your organization to one endpoint. You configure that endpoint (URL and optional secret) using the endpoints below. A single payload field,webhook_event, tells your receiver which event triggered the delivery. See End of Call and End of Sequence Report for the payload shapes.
Delivery Model
- One URL per organization. Every webhook Clarion sends goes to this URL.
- Opt-in per agent / campaign. Whether a given voice agent or sequence definition emits a webhook is a separate per-entity setting managed in the Clarion dashboard. If the agent or campaign has webhooks disabled, no delivery is attempted.
- Secret is optional. If you set a
secret, Clarion includes it as anX-Clarion-Secretheader on every request so your receiver can verify the caller. Every request is also signed; see Verifying Webhook Signatures.
Get the Current Webhook Configuration
GET
GET /config/organization/webhooknull if none is set.
Response
integer
The unique identifier for the webhook configuration row.
integer
The organization this webhook belongs to.
string
The endpoint Clarion will POST webhook payloads to.
string | null
The optional shared secret sent as the
X-Clarion-Secret header. null if no
secret is configured.string
ISO 8601 timestamp when the configuration was created.
string
ISO 8601 timestamp when the configuration was last updated.
Create or Update the Webhook Configuration
PUT
PUT /config/organization/webhookRequest Body
string
required
The endpoint Clarion will POST webhook payloads to. Must be reachable from the
public internet.
string | null
Optional shared secret. When set, Clarion sends it in the
X-Clarion-Secret
header on every delivery. Pass null or omit to clear.Response
Returns the saved configuration, with the same shape asGET /config/organization/webhook.
Delete the Webhook Configuration
DELETE
DELETE /config/organization/webhook204 No Content.