> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hookmyapp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Use the HookMyApp test WhatsApp number and start sending and receiving messages.

## What you will have

A ready-made chat app runs on your laptop.<br />
You can start sending and receiving WhatsApp messages in two minutes.

## Install and authenticate

```bash theme={null}
npm install -g @gethookmyapp/cli
hookmyapp login
```

## Start sandbox session

```bash theme={null}
hookmyapp sandbox start
```

The CLI shows a code and a QR.<br />
Open the QR on your phone and send the prefilled WhatsApp message to HookMyApp test number.<br />
After that, your phone is connected to this sandbox session.

HookMyApp provides the test WhatsApp number, so you can start building before you connect your own.

## Clone and run starter kit

```bash theme={null}
git clone https://github.com/hookmyapp/webhook-starter-kit.git
cd webhook-starter-kit
npm install
hookmyapp sandbox env --write .env
npm start
```

You now have a ready-made chat app running locally.<br />
Change it, restart it, and keep testing with the HookMyApp test number.

## Listen for messages

```bash theme={null}
hookmyapp sandbox listen --path /webhook/whatsapp
```

This tells HookMyApp to send sandbox WhatsApp messages to your computer while the command is running.<br />
`--path /webhook/whatsapp` is the route in your local chat app that receives the messages.

## Send test message

```bash theme={null}
hookmyapp sandbox send --message "hello from my app"
```

This sends a test WhatsApp message through the sandbox.<br />
You can also WhatsApp the test number from your connected phone.<br />
Messages appear in the starter kit chat. Reply from the chat input when you want to test sending.

## Connect WhatsApp number

```bash theme={null}
hookmyapp channels connect
```

This opens Meta connect flow.<br />
Choose your business, choose or create a WhatsApp Business Account, and verify the phone number.

### List channels

```bash theme={null}
hookmyapp channels list
```

This shows the WhatsApp numbers connected to your workspace.

You can connect a brand-new number or one you already use in the WhatsApp Business app.<br />
See [Connect WhatsApp](/whatsapp/connect-waba) for both paths.

### Pull number env values

```bash theme={null}
hookmyapp channels env ch_xxxxxxxx --write .env
```

This replaces the sandbox values in `.env` with values for your connected number.<br />
Your app gets a send URL, a channel token, your phone number ID, your WhatsApp Business Account ID, your HookMyApp channel ID, a verify token, and a webhook signing secret.<br />
Use it to send from your connected WhatsApp number.<br />
The receiver code does not change.<br />
Use the updated env values when you send from your connected number.

### Listen locally to number

```bash theme={null}
hookmyapp channels listen ch_xxxxxxxx --path /webhook/whatsapp
```

This tells HookMyApp to send messages from your connected WhatsApp number to your computer while the command is running.<br />
`--path /webhook/whatsapp` is the route in your local chat app that receives the messages.<br />
Stop the CLI with Ctrl-C when you are done.

Real WhatsApp messages to your verified number now arrive on your laptop.<br />
You can reply from the starter kit chat with your connected number too.

### Set deployed webhook URL

```bash theme={null}
hookmyapp channels webhook set ch_xxxxxxxx \
  --url https://api.yourapp.com/webhook/whatsapp \
  --verify-token $(openssl rand -hex 32)
```

Run this when your receiver is deployed behind a stable public URL.

## Next steps

* [Connect WhatsApp](/whatsapp/connect-waba): Connect a new or existing WhatsApp number.
* [Send text](/whatsapp/send-messages/text): Send your first WhatsApp text message.
* [Receive webhooks](/whatsapp/receive-webhooks): Verify the signature and acknowledge fast.
* [Build with AI](/whatsapp/build-with-ai): Let Cursor, Codex, or Claude Code do this for you.
