Creating an App
Set up a BYON App with a unique slug and API key.
A BYON App is your application endpoint in Pipes.bot. It groups your BYON numbers, holds your API key, and defines where messages are delivered.
Creating an App
Navigate to the Apps section in your Pipes.bot dashboard and click Create App.
You'll need to provide:
| Field | Description |
|---|---|
| Name | A display name for your App (e.g. "Customer Support Bot") |
| Slug | A unique URL-safe identifier (e.g. support-bot). Cannot be changed after creation |
After creation, your App's ak_ API key is displayed once. Copy and store it securely — it cannot be retrieved again.
API key
Each App has a single API key prefixed with ak_. Use this key for all BYON operations:
- Sending messages via
POST /v1/messages/send - Authenticating WebSocket connections
- Managing BYON numbers programmatically
Authorization: Bearer ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxRegenerating your API key
If your key is compromised, you can regenerate it from the App settings page. This immediately revokes the old key — any integrations using it will stop working.
Branding
You can customize how your App appears by setting optional branding fields:
| Field | Description |
|---|---|
| Display Name | Shown in the dashboard and admin views |
| Description | A short description of what your App does |
App limits
Each BYON number costs $5/month as an add-on to your Pro or Pro+ plan. There is no hard limit on the number of BYON numbers per App — add as many as your use case requires.
Next steps
- Embedded Signup — Connect your first WhatsApp Business number
- Webhook Delivery — Configure where messages are sent