API Keys
API keys let your own code and third-party tools talk to the WA Orbit API securely. Each key is tied to your account and carries the permissions you assign, so you can control exactly what an integration can do.
Create an API Key
- 1
Open the Developers page
Go to Settings > Developers in the WA Orbit dashboard. You will see sections for API keys and webhooks.
- 2
Create an API key
Click "Create API Key", give it a name you recognize (for example "Production CRM"), and choose its permissions. Save the key immediately — it is shown only once.
- 3
Store the key securely
Keep the key in your server environment or a password manager. Treat it like a password. WA Orbit never stores or shows the full key again after creation.
- 4
Add an API key to your requests
Send the key in the Authorization header of your API requests using the format "Bearer YOUR_API_KEY". The key identifies your account on every call.
Webhooks
Webhooks let WA Orbit push real-time events to your server automatically — for example when a message is received, a campaign completes, or a message status changes. You can configure the URL WA Orbit should deliver each event to from the same Developers page.
Best Practices
- Create a separate key for each integration so you can revoke one without affecting others
- Verify webhook payloads with the signature header to make sure they are really from WA Orbit
- Use a publicly reachable HTTPS endpoint for your webhook URL
- Rotate or revoke keys you no longer use to keep your account secure
Important
The full API key is shown only once at creation. If you lose it, you must revoke it and create a new one — WA Orbit cannot recover the original key for security reasons.