Integrations and API keys
This page covers how Davies CXsmart connects to your other systems — webhooks that push events out, and API keys that let your applications call the platform with scoped access.
Webhooks
A webhook sends an HTTP request to a URL you control whenever a chosen event happens — for example a new response, an updated response, or a fired alert. Use them to push feedback into your own systems in real time.
On the Integrations page you can:
- Register a webhook — provide a target URL (HTTPS recommended) and choose which events trigger it. Requires
integrations.manage. - List your webhooks.
- Test a webhook by firing a sample payload to confirm your endpoint responds.
- Remove a webhook.
API keys
An API key authenticates programmatic access to the Davies CXsmart API for your client account. Keys are created on the API keys page.
- Create a key — give it a name and select its scopes. The secret is shown once on creation — copy it then, because it can't be retrieved again.
- List keys — see your keys with their names and metadata (never the secret).
- Revoke a key — disable it immediately.
Scopes — what a key can do
Each key carries granular scopes that control exactly what it may access. Scopes come in read, write, and admin tiers, plus individual permissions.
| Scope choice | Effect |
|---|---|
| Empty scope set | The key grants no access at all. A key with no scopes can do nothing. |
| Individual permissions | The key can do exactly what those permissions allow, and nothing else. |
| Read / write tiers | Bundles of read-only or read-and-write access. |
| Admin scope | Full access — the broadest grant. |
:::caution Two things to remember
- An empty scope set grants nothing — if a key seems to do nothing, check that it actually has scopes.
- The admin scope is full access — grant it only when an integration genuinely needs everything. :::
Give each integration the least access it needs: prefer specific read or write scopes over admin. Revoke keys you no longer use.
Next steps
- Features & audit — track configuration changes, including key and webhook management.
- Users & roles — the permission model that scopes mirror.