Skip to main content

Overview

Create a new WhatsApp Business integration by connecting a WhatsApp phone number to your Weya AI workspace. Once connected, the number can be used with WhatsApp Agents, templates, and automated conversations.

Prerequisites

  • Bearer Token authentication
  • A valid WhatsApp Business Account
  • A verified WhatsApp Business phone number

Request

string
required
Bearer token for authenticated workspace access.

Request Body

string
required
Unique identifier of the WhatsApp Business phone number.
string
required
Meta WhatsApp Business Account ID.
string
required
Meta access token used to authorize the integration.
string
required
WhatsApp Business phone number including the country code.
string
Display name associated with the WhatsApp Business account.

Response

boolean
Indicates whether the integration was created successfully.
integer
HTTP status code.
string
Confirmation message.
object
Details of the newly created WhatsApp integration.
string
Unique identifier of the integration.
string
WhatsApp Business Phone Number ID.
string
Connected WhatsApp phone number.
string
Business display name.
string
Current integration status.

Error Handling

Each WhatsApp Business phone number can only be connected to one workspace at a time.
Typical workflow:
  1. Validate the WhatsApp number.
  2. Create the WhatsApp integration.
  3. Create a WhatsApp Agent.
  4. Assign the agent to the integrated phone number.
  5. Configure webhooks and templates.