Authorization header. The key identifies your workspace and authorizes access to endpoints that are available to API clients.
API keys
Create and manage API keys in the DialNexa dashboard under Settings > API Keys. An API key has two parts separated by a colon. The full value must be sent as the Bearer token.Send the Bearer token
Pass the API key in theAuthorization header on every API-key request.
401 Unauthorized.
Endpoint access
The v1 reference includes endpoints exported from the backend with the explicitV1 Swagger tag and documented under Endpoints - v1. These documented v1 endpoints are intended for Bearer API-key access.
Common mistakes
- Sending only the key ID instead of the full
key_id:secretvalue. - Using
x-api-keyinstead of the BearerAuthorizationheader for v1 endpoints. - Assuming a legacy page has a v1 equivalent when it is not listed under Endpoints - v1.
Key management best practices
- Use one key per environment, such as development, staging, and production.
- Rotate keys on a schedule and immediately after suspected exposure.
- Store keys in environment variables or a secrets manager.
- Remove unused keys from the dashboard.
Webhook signature verification
Incoming webhook payloads from DialNexa are signed with HMAC-SHA256 using the secret configured for that webhook. Verify thex-dialnexa-signature header before trusting the payload.