Skip to main content
POST
Connect Meta WhatsApp channel

Overview

After creating a channel of type META_WHATSAPP, you need to connect it to a WhatsApp Business number. There are two ways:
  • Via dashboard — Guided flow directly in the Dashboard
  • Via SDK + API — Integrate the connection flow into your system

Connection via dashboard

The simplest way. Go to the Dashboard, select the created channel and follow the guided connection flow.

Connection via SDK + API

Use this flow when you want your user to connect the channel from within your system, without needing to access the dashboard. The flow has 3 steps:
1

Frontend — Start connection with SDK

In your application’s frontend, use the SDK to start the connection flow. The SDK will open the WhatsApp authentication process and return the necessary information.
The publicKey can be exposed in the frontend. See more at Authentication.
2

Frontend → Backend — Send data

The SDK returns an object with the connection information. Send this data to your application’s backend:
3

Backend — Finalize connection via API

In the backend, call the connection API passing the data received from the frontend:POST /v1/channels/{channelId}/connect
This call must be made in the backend, as it uses the Secret Key which should never be exposed in the frontend.

Flow summary

After connection, the channel is ready to send and receive messages. Use the channelId in the free messages and templates endpoints.

Authorizations

Authorization
string
header
required

Secret Key generated in the Hub Message Security panel

Path Parameters

channelId
string
required

Channel ID (obtained via Create channel)

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Body

application/json
wabaId
string
required

WhatsApp Business Account ID

phoneId
string
required

Phone number ID

code
string
required

Authorization code generated by WhatsApp

coexistence
boolean
required

Whether the number is in coexistence mode

Response

Channel connected successfully

success
boolean

Indicates whether the operation was successful