Team and account API keys
API keys
Create keys that let your own tools send messages and read your data through the WAGenie API.
What it does
An API key lets another program talk to WAGenie. The public API lives under /api/v1. You send the key in the Authorization header as Bearer, followed by the key.
Each key has scopes. A scope is one thing the key may do, such as send messages or read contacts. A key can do only what its scopes allow.
Where to find it
SettingsAPI keys
How to use it
- Open Settings and choose API keys. Only an Admin or an Owner can create keys.
- Press New API key and name it after the tool that will use it, for example Zapier automation.
- Tick only the scopes it needs: send messages, read messages, read contacts, write contacts, read conversations, launch broadcasts, or manage outbound event webhooks.
- Press Create key. Copy the key now. It is shown only once.
- Put the key in your tool. To check it works, call GET /api/v1/me.
- To stop a key, press Revoke next to it.
Example for a business
A gym
A gym uses a spreadsheet tool to add every new member as a contact. The owner makes a key with only the Create and update contacts scope. If the key is ever leaked, it can add contacts, but it cannot send messages.
Good to know
- If you lose a key, revoke it and make a new one. WAGenie cannot show it again.
- A key with no scopes can still call the /me address to check it works.
- The list shows when each key was created and last used.
- Treat a key like a password. Never put it in a public place.