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

# WhatsApp Business

> How to set up the WhatsApp Business connector, plus the actions and events that are available.

![WhatsApp Business](https://stackone-logos.com/api/whatsapp/filled/svg)

v2.2.0[See changelog](https://docs.stackone.com/connectors/whatsapp-business/changelog.md)

[87 actions](#actions) · [14 events](#events) · 2 auth methods

Messaging
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/whatsapp-business/guides/connector-profile/oauth-2-0.md)
>
> Connects through a Meta app you register with Facebook Login for Business. Each user approves access with their own Meta...

> [card] [System User Access Token · Connector Profile](https://docs.stackone.com/connectors/whatsapp-business/guides/connector-profile/system-user-access-token.md)
>
> Uses an access token generated for a system user in Meta Business Settings, so the connection runs as the system user ra...

Optionally, configure receiving Events for WhatsApp Business into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/whatsapp-business/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/whatsapp-business/guides/link-account/oauth-2-0.md)

> [card] [System User Access Token · Link Account](https://docs.stackone.com/connectors/whatsapp-business/guides/link-account/system-user-access-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

business\_management

whatsapp\_business\_management

whatsapp\_business\_messaging

No scopes found

87 actions

ActionDescriptionRequired scopes

Get WhatsApp Business Account`whatsapp-business_get_whatsapp_business_account`

Get details of the WhatsApp Business Account.

`whatsapp_business_management`

Update WhatsApp Business Account`whatsapp-business_update_whatsapp_business_account`

Update configuration and settings for the WhatsApp Business Account.

`whatsapp_business_management`

Get Subscribed Apps`whatsapp-business_get_subscribed_apps`

Get list of applications subscribed to webhook events for the WhatsApp Business Account.

`whatsapp_business_management`

Get Schedules`whatsapp-business_get_schedules`

Get schedules for the WhatsApp Business Account.

`whatsapp_business_management`

Create Schedule`whatsapp-business_create_schedule`

Create a campaign schedule that sends a message template to an audience at a set time.

`whatsapp_business_management`

Get Owned WhatsApp Business Accounts`whatsapp-business_get_owned_whatsapp_business_accounts`

List the WhatsApp Business Accounts owned by a Meta business portfolio.

`business_management``whatsapp_business_management`

Get Client WhatsApp Business Accounts`whatsapp-business_get_client_whatsapp_business_accounts`

List the WhatsApp Business Accounts that other businesses have shared with a Meta business portfolio.

`business_management``whatsapp_business_management`

List Flows`whatsapp-business_list_flows`

List the WhatsApp Flows on a WhatsApp Business Account.

`whatsapp_business_management`

Get Flow`whatsapp-business_get_flow`

Get the details of a WhatsApp Flow.

`whatsapp_business_management`

Create Flow`whatsapp-business_create_flow`

Create a WhatsApp Flow on a WhatsApp Business Account.

`whatsapp_business_management`

Update Flow Metadata`whatsapp-business_update_flow_metadata`

Update the name, categories, endpoint, or connected app of a WhatsApp Flow.

`whatsapp_business_management`

Update Flow JSON`whatsapp-business_update_flow_json`

Replace the Flow JSON that defines a WhatsApp Flow's screens.

`whatsapp_business_management`

List Flow Assets`whatsapp-business_list_flow_assets`

List the assets of a WhatsApp Flow, including a download URL for its Flow JSON.

`whatsapp_business_management`

Publish Flow`whatsapp-business_publish_flow`

Publish a WhatsApp Flow so it can be sent to customers.

`whatsapp_business_management`

Deprecate Flow`whatsapp-business_deprecate_flow`

Deprecate a published WhatsApp Flow so it can no longer be sent or opened.

`whatsapp_business_management`

Delete Flow`whatsapp-business_delete_flow`

Delete a DRAFT WhatsApp Flow.

`whatsapp_business_management`

Create Group`whatsapp-business_create_group`

Create a new WhatsApp group for business messaging.

`whatsapp_business_messaging`

Get Group Invite Link`whatsapp-business_get_group_invite_link`

Get the current invite link for a WhatsApp group.

`whatsapp_business_messaging`

Reset Group Invite Link`whatsapp-business_reset_group_invite_link`

Reset and generate a new invite link for a WhatsApp group.

`whatsapp_business_messaging`

Delete Group Invite Link`whatsapp-business_delete_group_invite_link`

Delete an existing invite link for a WhatsApp group.

`whatsapp_business_messaging`

Get Join Requests`whatsapp-business_get_join_requests`

Get pending join requests for a WhatsApp group.

`whatsapp_business_messaging`

Approve Join Requests`whatsapp-business_approve_join_requests`

Approve one or more pending join requests for a WhatsApp group.

`whatsapp_business_messaging`

Reject Join Requests`whatsapp-business_reject_join_requests`

Reject one or more pending join requests for a WhatsApp group.

`whatsapp_business_messaging`

Send Group Invite Template`whatsapp-business_send_group_invite_template`

Send a template message with a group invite link to a WhatsApp user.

`whatsapp_business_messaging`

Remove Group Participants`whatsapp-business_remove_group_participants`

Remove participants from a WhatsApp group.

`whatsapp_business_messaging`

Get Group`whatsapp-business_get_group`

Get metadata about a WhatsApp group.

`whatsapp_business_messaging`

Get Active Groups`whatsapp-business_get_active_groups`

Get a list of active WhatsApp groups for a business phone number.

`whatsapp_business_messaging`

Update Group`whatsapp-business_update_group`

Update a WhatsApp group's subject, description, or profile picture.

`whatsapp_business_messaging`

Delete Group`whatsapp-business_delete_group`

Delete a WhatsApp group and remove all participants.

`whatsapp_business_messaging`

Send Group Message`whatsapp-business_send_group_message`

Send a text message to a WhatsApp group.

`whatsapp_business_messaging`

Get Unified Credentials`whatsapp-business_unified_get_me`

Get the current WhatsApp Business connection's unified credentials and identity.

List Unified Organizations`whatsapp-business_unified_list_organizations`

List unified organizations in WhatsApp Business.

`whatsapp_business_management`

Get Unified Organization`whatsapp-business_unified_get_organization`

Get a unified WhatsApp Business organization by ID.

`whatsapp_business_management`

List Unified Resource Types`whatsapp-business_unified_list_resource_types`

List unified resource types in WhatsApp Business.

`whatsapp_business_management`

List Unified Resource Users`whatsapp-business_unified_list_resource_users`

List unified resource users in WhatsApp Business.

`whatsapp_business_management`

List Unified Roles`whatsapp-business_unified_list_roles`

List unified roles in WhatsApp Business.

`whatsapp_business_management`

Get Unified Role`whatsapp-business_unified_get_role`

Get a unified WhatsApp Business role by ID.

`whatsapp_business_management`

List Unified Users`whatsapp-business_unified_list_users`

List unified users in a Meta business portfolio linked to a WhatsApp Business Account.

`business_management``whatsapp_business_management`

Get Unified User`whatsapp-business_unified_get_user`

Get a unified WhatsApp Business user by ID.

`business_management``whatsapp_business_management`

Upload Media`whatsapp-business_upload_media`

Upload an image, video, audio, document, or sticker file to a business phone number and get a media ID.

`whatsapp_business_messaging`

Retrieve Media URL`whatsapp-business_retrieve_media_url`

Get a temporary download URL and file details for a media ID.

`whatsapp_business_messaging`

Download Media`whatsapp-business_download_media`

Download the file content of a media ID as base64, with its MIME type.

`whatsapp_business_messaging`

Delete Media`whatsapp-business_delete_media`

Delete a media file by its media ID.

`whatsapp_business_messaging`

Send Text Message`whatsapp-business_send_text_message`

Send a text message to a WhatsApp user.

`whatsapp_business_messaging`

Send Template Message`whatsapp-business_send_template_message`

Send a pre-approved template message to a WhatsApp user.

`whatsapp_business_messaging`

Send Image Message`whatsapp-business_send_image_message`

Send an image message to a WhatsApp user.

`whatsapp_business_messaging`

Send Video Message`whatsapp-business_send_video_message`

Send a video message to a WhatsApp user.

`whatsapp_business_messaging`

Send Audio Message`whatsapp-business_send_audio_message`

Send an audio message to a WhatsApp user.

`whatsapp_business_messaging`

Send Document Message`whatsapp-business_send_document_message`

Send a document to a WhatsApp user.

`whatsapp_business_messaging`

Send Location Message`whatsapp-business_send_location_message`

Send a location to a WhatsApp user.

`whatsapp_business_messaging`

Send Contact Message`whatsapp-business_send_contact_message`

Send contact information to a WhatsApp user.

`whatsapp_business_messaging`

Send Interactive Message`whatsapp-business_send_interactive_message`

Send an interactive message with buttons or lists.

`whatsapp_business_messaging`

Send Reaction`whatsapp-business_send_reaction`

Send a reaction emoji to a message.

`whatsapp_business_messaging`

Send Sticker Message`whatsapp-business_send_sticker_message`

Send a sticker to a WhatsApp user.

`whatsapp_business_messaging`

Mark Message As Read`whatsapp-business_mark_message_as_read`

Mark an incoming message as read, displaying blue check marks to the sender, and optionally show a typing indicator.

`whatsapp_business_messaging`

Get Message History`whatsapp-business_get_message_history`

Retrieve per-message delivery status events (not message content) for messages sent from a business phone number.

`whatsapp_business_messaging`

Get WhatsApp Business Account Phone Numbers`whatsapp-business_get_whatsapp_business_account_phone_numbers`

List all phone numbers for the WhatsApp Business Account.

`whatsapp_business_management`

Get Phone Number`whatsapp-business_get_phone_number`

Get details of a specific phone number.

`whatsapp_business_management`

Create WhatsApp Business Account Phone Number`whatsapp-business_create_whatsapp_business_account_phone_number`

Add a phone number to the WhatsApp Business Account and start its onboarding.

`whatsapp_business_management`

Register Phone Number`whatsapp-business_register_phone_number`

Register a phone number for WhatsApp Business.

`whatsapp_business_management`

Deregister Phone Number`whatsapp-business_deregister_phone_number`

Deregister a phone number from WhatsApp Business.

`whatsapp_business_management`

Request Verification Code`whatsapp-business_request_verification_code`

Request a verification code for a phone number.

`whatsapp_business_management`

Verify Code`whatsapp-business_verify_code`

Verify a phone number with the received verification code.

`whatsapp_business_management`

Set Two-Step Verification PIN`whatsapp-business_set_two_step_pin`

Set or update the two-step verification PIN for the phone number.

`whatsapp_business_management`

Block Users`whatsapp-business_block_users`

Block one or more users from sending messages to your business number.

`whatsapp_business_messaging`

Unblock Users`whatsapp-business_unblock_users`

Unblock one or more previously blocked users.

`whatsapp_business_messaging`

Get Blocked Users`whatsapp-business_get_blocked_users`

Get a list of all blocked users for a phone number.

`whatsapp_business_messaging`

Configure Conversational Automation`whatsapp-business_configure_conversational_automation`

Configure conversational automation settings for a phone number.

`whatsapp_business_management`

Manage Call`whatsapp-business_manage_call`

Initiate, accept, reject, terminate, or manage a WhatsApp call.

`whatsapp_business_messaging`

Check Call Permissions`whatsapp-business_check_call_permissions`

Check whether you have permission to call a WhatsApp user.

`whatsapp_business_messaging`

Get Business Profile`whatsapp-business_get_business_profile`

Get the business profile information.

`whatsapp_business_management`

Update Business Profile`whatsapp-business_update_business_profile`

Update the business profile information including about text, address, description, email, websites, and industry catego...

`whatsapp_business_management`

Get Message Templates`whatsapp-business_get_message_templates`

List all message templates for the WhatsApp Business Account.

`whatsapp_business_management`

Get Message Template`whatsapp-business_get_template`

Get details of a specific message template.

`whatsapp_business_management`

Create Message Template`whatsapp-business_create_template`

Create a new message template for the WhatsApp Business Account.

`whatsapp_business_management`

Delete Message Template`whatsapp-business_delete_template`

Delete a message template.

`whatsapp_business_management`

Edit Message Template`whatsapp-business_edit_template`

Update an existing message template.

`whatsapp_business_management`

Get Assigned Users`whatsapp-business_get_assigned_users`

Get users assigned to the WhatsApp Business Account with their permissions.

`whatsapp_business_management`

Add Assigned User`whatsapp-business_add_assigned_user`

Add a user to the WhatsApp Business Account with specified permissions.

`whatsapp_business_management`

Remove Assigned User`whatsapp-business_remove_assigned_user`

Remove a user's access from the WhatsApp Business Account.

`whatsapp_business_management`

List Business Users`whatsapp-business_list_business_users`

List all business users associated with the Business account.

`business_management`

List System Users`whatsapp-business_list_system_users`

List all system users associated with the Business account.

`business_management`

Create Business User`whatsapp-business_create_business_user`

Invite a user to the Business account by email with a specified role.

`business_management`

List Pending Users`whatsapp-business_list_pending_users`

List the invitations to join the Business account that Meta returns as pending users.

`business_management`

Get Business User`whatsapp-business_get_business_user`

Get one business user of the Business account by ID.

`business_management`

List User Businesses`whatsapp-business_list_user_businesses`

List the business portfolios a user belongs to, with the user's roles in each.

`business_management`

Get First Business User`whatsapp-business_get_first_business_user`

Read the id of one business user of the Meta business portfolio, to check that the access token can list people.

`business_management`

## Events

Tags

Select all
|
Clear

Accounts

Contacts

Groups

Health Checks

Messages

Phone Numbers

Templates

Webhooks

No tags found

14 events

EventDescriptionTags

Webhook Verification`whatsapp-business_webhook_verification`

Responds to Meta's webhook verification request by returning the hub.challenge value as plain text.

Webhooks

Active Check`whatsapp-business_active_check`

Responds with 200 OK to any webhook delivery that carries no WhatsApp Business Account entries.

Health Checks

Message Received`whatsapp-business_webhook_message_received`

Fired when a WhatsApp user sends a message to a business phone number.

Messages

Message Status Updated`whatsapp-business_webhook_message_status_updated`

Fired when a message sent from a business phone number is sent, delivered, read, or fails.

Messages

Template Status Updated`whatsapp-business_webhook_template_status_updated`

Fired when a message template is approved, rejected, paused, disabled, or otherwise changes review status.

Templates

Template Quality Updated`whatsapp-business_webhook_template_quality_updated`

Fired when a message template's quality rating changes.

Templates

Phone Number Quality Updated`whatsapp-business_webhook_phone_number_quality_updated`

Fired when a business phone number's messaging limit or throughput changes.

Phone Numbers

Account Updated`whatsapp-business_webhook_account_updated`

Fired when a WhatsApp Business Account changes, such as a restriction, policy violation, verification change, or deletio...

Accounts

Account Review Updated`whatsapp-business_webhook_account_review_updated`

Fired when the review of a WhatsApp Business Account is completed.

Accounts

Account Alert`whatsapp-business_webhook_account_alert`

Fired when Meta raises an alert about a WhatsApp Business Account, business, or phone number, such as a messaging limit...

Accounts

User Preferences Updated`whatsapp-business_webhook_user_preferences_updated`

Fired when a WhatsApp user stops or resumes marketing messages from the business.

Contacts

Group Lifecycle Updated`whatsapp-business_webhook_group_lifecycle_updated`

Fired when a group is created or deleted, including the result of create\_group and delete\_group requests.

Groups

Group Participants Updated`whatsapp-business_webhook_group_participants_updated`

Fired when participants join or leave a group, or a join request is created or resolved.

Groups

Group Settings Updated`whatsapp-business_webhook_group_settings_updated`

Fired when a group's subject, description, or profile picture update completes.

Groups


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.