Why it matters
API keys allow Whippy to work automatically with other systems you rely on, such as CRMs, ATS platforms, or internal tools. They enable secure, automated actions like sending messages, syncing contacts, and triggering workflows without manual intervention.
Key Concepts
API key: A secure identifier for your Whippy organization that allows external systems to authenticate and perform actions on your behalf.
Automation: A process where actions like sending messages or updating records happen automatically without someone clicking a button in Whippy.
Integration: A connection between Whippy and another system, such as a CRM, ATS, or internal application, enabled using an API key.
Security: API keys grant automated access to your account and should be treated like passwords.
Step-by-Step: Create an API Key
Open Whippy from any page in the platform.
Click the code icon in the top navigation bar. (This is the second icon and opens the Developers page.)
Confirm you are on the API Keys page.
Click Add API Key. (Available from the top-left corner or the main screen.)
Enter a clear, descriptive name in the API Key Name field.
Click Yes, Create Key.
Confirm the success banner appears indicating the API key was created.
Copy the API key using the copy icon.
Securely store the API key for future use.
Tips and Best Practices
Use descriptive names to indicate what each API key is used for.
Store API keys securely and share them only with trusted integration partners or internal teams.
Treat API keys like passwords. Do not paste them into public documents or code repositories.
Create separate API keys for different systems or use cases when possible.
Delete or disable API keys that are no longer needed.
Troubleshooting
Issue | Possible Cause | Fix |
API key not visible | Key creation not completed | Recreate the API key and confirm the success banner |
Integration fails to authenticate | Incorrect API key used | Verify the key matches the one stored in the external system |
Security concern | API key exposed | Delete the key immediately and create a new one |
No automation needed | Only using Whippy UI | No API key required |