API keys (for developers)
Connect your own systems to NexusBot with the REST API.
The NexusBot API lets your own website, shop or system send messages, add contacts or start broadcasts. This is for developers. Most businesses don't need it.
Create a key
- Go to Settings → API keys and click New API key.
- Name it after the system that will use it, for example "Website order form".
- Tick only the Scopes it needs.
- Click Create key, then Copy it and store it somewhere safe.
Scopes
| Scope | Allows |
|---|---|
| messages:send | Send WhatsApp messages |
| messages:read | Read messages and delivery status |
| contacts:read | List and read contacts |
| contacts:write | Create and update contacts |
| conversations:read | List and read conversations |
| broadcasts:send | Launch broadcasts |
| webhooks:manage | Register webhooks for events |
Use the key
Send it in the request header:
Authorization: Bearer YOUR_API_KEY
To check it works, call GET /api/v1/me. The base address is https://app.nexus-aurora.com/api/v1.
Each key shows when it was created, last used and when it expires. Only Admins can create or revoke keys.
Was this article helpful?