Difficulty: Advanced | Time: 4 min | Tier: Scale+
Scale Tier Feature
API access is available on Scale ($299/mo) and above. Compare plans
API keys let external applications authenticate with DreamFlow’s API. Each key grants full read/write access to your workspace data, so manage them carefully.
Generating a Key
- Navigate to Settings > Integrations > API.
- Click Generate New API Key.
- Give the key a Name (e.g., “Zapier Integration” or “Internal Dashboard”) to identify its purpose.
- The key is displayed once. Copy it immediately and store it in your application’s environment variables or a secrets manager.
Rotating a Key
- Go to Settings > Integrations > API.
- Click Rotate next to the key you want to replace.
- A new key is generated. The old key remains active for 24 hours to give you time to update your applications.
- After 24 hours, the old key is permanently revoked.
Revoking a Key
- Click Revoke next to the key. This takes effect immediately — any application using this key will lose access.
Warning
Never share API keys in emails, chat messages, or public code repositories. If a key is accidentally exposed, revoke it immediately and generate a new one.
Related Articles
Need more help? Ask Sally in the chat bubble!
Was this helpful?
Have more questions? Get instant answers.
Related Articles
Still need help? Our support team is here for you.
Contact Support