Developers · Send notifications
Connect an application
Register your backend as a connected app and get its credentials.
A connected app is one of your systems, such as your order backend or login service, that is allowed to send WhatsApp template messages through your workspace. Workspace admins register apps in Team & channelsConnected apps.
Register an app
Click Register app and fill in the form
Field What to enter App ID A short, lowercase identifier such as acme-orders. It can’t be changed later and is sent asx-app-id. If you seeapp_id already exists, pick a more specific one, for example with your business name in it.Display name A readable name, shown in the app list and the notification logs. Service key Click Generate for a strong random key. It is sent as x-app-service-key.Phone number override Optional. Send this app’s messages from a specific number instead of the workspace default. Copy the credentials
After saving, App registered! shows the service key, your API base URL and a ready-to-run request. Copy the key now: it is never shown again.
Add them to your backend’s secrets
.envCODIQUE_API_URL=https://api.example.comCODIQUE_APP_ID=acme-ordersCODIQUE_SERVICE_KEY=<the-service-key>Check the connection
Terminalcurl https://api.example.com/health/auth \ -H "x-app-id: $CODIQUE_APP_ID" \ -H "x-app-service-key: $CODIQUE_SERVICE_KEY"
What happens when your app sends
- The message goes out from the app’s number, or the workspace default.
- It is logged in InsightsNotification logs, successful or not, with the error if it failed.
- It appears in the inbox in the customer’s thread, so if they reply, your team sees it in context. New threads start under General.
Manage apps
| Task | How |
|---|---|
| See the request for an app | Click curl on its row. The key appears as YOUR_SERVICE_KEY, because it is never shown again. |
| Change the sending number | Edit the app’s phone number override. |
| Stop an app | Deactivate it. Its requests are refused at once; reactivate to restore them. |
| Replace a lost or exposed key | Register a new app, move your backend to it, then deactivate the old one. |
Next: use template codes to get the request for each of your templates.
Still stuck? Contact us with what you were doing and the exact message you saw.