BYON Quickstart

Clone and run the BYON demo app to connect a WhatsApp Business number, manage templates, and send messages.

Get up and running with BYON by cloning the demo app. It covers the full lifecycle — connecting a number via Embedded Signup, listing templates, and sending messages.

GitHub: pipes-bot-byon-demo

Prerequisites

A Pro or Pro+ Pipes.bot plan
An App API key (ak_...) — see Creating an App
Node.js 18+
pnpm

Setup

Clone the repo and install dependencies:

git clone https://github.com/id49/pipes-bot-byon-demo.git
cd pipes-bot-byon-demo
pnpm install

Create a .env file with the following variables:

Variable	Description
`PIPES_APP_API_KEY`	Your App API key (`ak_...`)
`PIPES_APP_SLUG`	Your App's slug
`PARTNER_REDIRECT_URL`	Redirect URL after Embedded Signup
`PIPES_API_BASE_URL`	API base (default: `https://api.pipes.bot`)

Start the development server:

pnpm dev

What the demo covers

The demo app walks through four BYON flows:

Connect

Starts the Embedded Signup flow by generating a token via POST /v1/apps/token and redirecting the user to onboard their WhatsApp Business number.

See Embedded Signup for the full reference.

Templates

Fetches approved message templates for a connected number via GET /v1/pool-numbers/{id}/templates.

See Template Management for details on listing and using templates.

Send Template

Sends a template message to a recipient via POST /v1/messages/passthrough. Templates let you initiate conversations outside the 24-hour service window.

See Passthrough Messages for the full endpoint reference.

Send Message

Sends a plain text message via POST /v1/messages/app/send to a recipient on a connected BYON number.

See Sending Messages for the full endpoint reference.

Next steps

BYON Overview — Understand the App model and BYON architecture
Creating an App — Set up and manage Apps
Webhook Delivery — Configure message delivery to your server
Number Management — Monitor and manage connected numbers

BYON Quickstart

On this page