Scopes, expiry, rotating, and revoking tokens
Control what each API key can do: limit permissions with scopes, set an expiry date, rotate it, or revoke it when you no longer need it.
Watch this step in the video · Scopes: what the key can do
Once you know how to create an API key, the next step is managing its lifecycle securely: grant only the permissions it needs, let it expire, rotate it periodically, and revoke it when it's no longer used.
Scopes (permission boundaries)
Scopes define what the key is allowed to do. In the editor they're grouped:
- Contacts:
read:contacts,write:contacts - Messages:
read:messages,write:messages(send messages) - Channels:
read:channels - CRM:
read:crm,write:crm - Projects:
read:projects,write:projects - Webhooks:
manage:webhooks - Full access:
admin(all scopes)
If you leave every scope unchecked, the key gets full access (equivalent to
*). For security, check only the permissions the integration needs — the principle of least privilege.
Expiry
Under Expires at you can set a date and time. When that moment arrives, the key stops authenticating automatically. Leave it empty and the key never expires until you delete it. We recommend expiry dates for third-party or test credentials.
Rotating a key (Regenerate)
Rotating means replacing the secret while keeping the same configuration (name, scopes, workspace, expiry).
- Open API Keys and click Edit on the key.
- Click Regenerate.
- The old key is revoked and a new one is issued. Copy the new value from the "Copy and save now" dialog (shown only once).
- Update the integration with the new token.
Important: when you regenerate, the previous key stops working immediately. Schedule the change so you don't break the service.
Revoking (deleting)
Omnifox has no "inactive" state: revoke = delete.
- In the API Keys list, find the key.
- Click Delete and confirm.
The key stops authenticating at once and cannot be recovered.
Best practices
- Rotate production keys on a schedule (for example, every 90 days).
- Revoke any key you suspect is compromised right away.
- One key per integration, with minimal scopes and a clear name.
If it doesn't work
- My integration broke after regenerating: it's still using the old token. Load the new value.
- I can't see the Regenerate/Delete button: you need the Manage API keys permission.
Related articles
Related articles
-
How to connect integrations and external apps
Connect Omnifox with your favorite tools from the integrations catalog in just a few steps.
-
Integrations and API complete guide
Integrations and API in depth, in 30 chapters: API keys, real calls, signed webhooks, n8n, MCP and SDKs, all really working.
-
Connecting Omnifox to Azur, Siigo, Alegra, QuickBooks or another accounting system or ERP
Omnifox doesn't have a native connector for accounting systems or ERPs today. Here's how to connect them anyway with workflows, the HTTP node, n8n, Make, Zapier or the API, with examples.
-
Generate and use API keys and webhooks
Create API keys to access Omnifox programmatically and set up webhooks to receive real-time events.
-
Getting started with integrations (webhook / OAuth / API key)
Connect Omnifox with your other tools: what's available today, what's coming soon, and when to use a webhook, an OAuth connection or an API key.