Getting Started Guide

Get up and running with WhatAPI messaging automations in under 5 minutes by following these four steps.

Step 1: Sign In & Authentication

1. Navigate to the [WhatAPI Portal](/login/).
2. Authenticate securely using your email/password or Google Login.
3. Upon login, a secure Firebase ID Token (JWT) is generated and stored in your browser session.

Step 2: Initialize & Pair WhatsApp Session

1. Go to the **Connect WhatsApp** screen in the sidebar.
2. The dashboard fetches your assigned `whatsappSessionId` from your Firestore profile.
3. If no session is active on the OpenWA server, the system automatically initializes a fresh session.
4. Scan QR Code: A base64-encoded QR code will appear on the dashboard (refreshed every 60 seconds).
5. Open WhatsApp on your phone, go to **Linked Devices** > **Link a Device**, and scan the QR code.
6. The gateway polls the connection status every 3 seconds. Once paired, the status changes to `CONNECTED`.

Step 3: Configure Templates with Variables

Navigate to **Templates** to edit your e-commerce messages. You can use dynamic variables which will be auto-replaced with real customer data:

• Customer data: `{customer_name}`, `{customer_phone}`, `{customer_address}`
• Order details: `{order_number}`, `{order_total}`, `{currency}`, `{payment_method}`
• Shipping logs: `{shipping_city}`, `{tracking_number}`, `{tracking_url}`
• Products: `{items_list}`, `{items_count}`

Live Character Counter

The template editor includes a live character counter and preview rendering. We recommend sending a **test message** to your own phone before saving.

Step 4: Toggle Automations

1. Go to the **Automations** tab.
2. Toggle the switches for the e-commerce events you want to automate:

- Order Confirmed (`orders/create`)
- Order Paid (`orders/paid`)
- Order Shipped (`fulfillments/create`)
- Order Cancelled (`orders/cancelled`)
- Refund Processed (`refunds/create`)

1. Click **Save** to begin routing automatic notifications.