# WhatsApp

Enables interaction with customers through the WhatsApp Business API for messaging and automation. Only supports WhatsApp Business accounts, not WhatsApp Personal accounts.

- **Category:** phone & sms
- **Auth:** OAUTH2, API_KEY
- **Composio Managed App Available?** Yes
- **Tools:** 17
- **Triggers:** 1
- **Slug:** `WHATSAPP`
- **Version:** 20260323_00

## Frequently Asked Questions

### Why isn't my WhatsApp message being delivered?

WhatsApp has a 24-hour customer service window. Recipients only receive messages within 24 hours of their last message to you. To message outside this window, use a template message.

### Why is my WhatsApp connection failing with "Missing required fields"?

Ensure all required fields are provided when initiating the connection. See the [WhatsApp authentication details](https://docs.composio.dev/toolkits/whatsapp#authentication-details).

---

## Tools

### Create message template

**Slug:** `WHATSAPP_CREATE_MESSAGE_TEMPLATE`

Create a new message template for the WhatsApp Business Account. Templates must be approved by WhatsApp before they can be used. Templates are required for marketing messages and messages sent outside the 24-hour window.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique template name. Must be lowercase, alphanumeric with underscores only. Maximum 512 characters. Example: 'order_confirmation_v1'. |
| `category` | string ("AUTHENTICATION" | "MARKETING" | "UTILITY") | Yes | Template category. AUTHENTICATION: for OTP/verification codes. MARKETING: for promotional content (requires opt-in). UTILITY: for transactional updates like order status, appointments. |
| `language` | string | Yes | Template language code in ISO 639-1 format with country code. Examples: 'en_US' (US English), 'es_ES' (Spanish), 'pt_BR' (Brazilian Portuguese). |
| `components` | array | Yes | List of template components. Must include at least one BODY component. Can optionally include one HEADER and one BUTTONS component. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete message template

**Slug:** `WHATSAPP_DELETE_MESSAGE_TEMPLATE`

Delete a message template from the WhatsApp Business Account by name. This permanently removes the template and it cannot be recovered. When you delete a template by name, all templates with that name across all languages will be deleted. Names of deleted templates cannot be reused for 30 days. Important: Only delete templates that are no longer needed, as this operation is irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the template to delete. This will delete all templates with this name across all languages. |
| `waba_id` | string | No | WhatsApp Business Account ID to target. If not provided, the first WABA owned by the business is used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get business profile

**Slug:** `WHATSAPP_GET_BUSINESS_PROFILE`

Get the business profile information for a WhatsApp Business phone number. This includes business details like description, address, website, and contact info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated list of fields to retrieve. Default includes all available fields. |
| `phone_number_id` | string | Yes | The phone number ID to get the business profile for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get media info

**Slug:** `WHATSAPP_GET_MEDIA_INFO`

Get metadata and download URL for uploaded WhatsApp media. Returns media ID, download URL (valid for 5 minutes), MIME type, SHA256 hash, and file size. The download URL can be used to retrieve the actual media file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media_id` | string | Yes | The WhatsApp media ID to retrieve information for (obtained from media upload or webhook notifications). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get message templates

**Slug:** `WHATSAPP_GET_MESSAGE_TEMPLATES`

Get all message templates for the WhatsApp Business Account. Templates are required for sending messages outside the 24-hour window and for marketing/utility messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | string | No | Cursor for pagination to get templates after this cursor. |
| `limit` | integer | No | The maximum number of templates to retrieve. Default is 25. |
| `status` | string | No | Filter by template status: APPROVED, PENDING, REJECTED, DISABLED, PAUSED, LIMIT_EXCEEDED. |
| `waba_id` | string | No | Optional: WhatsApp Business Account ID to query. If not provided, uses the waba_id from your connection configuration. Only provide this if you need to override the configured WABA ID. |
| `category` | string | No | Filter by template category: AUTHENTICATION, MARKETING, UTILITY. |
| `language` | string | No | Filter by language code (e.g., 'en_US', 'es_ES'). |
| `name_or_content` | string | No | Filter templates by name or content substring. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get phone number

**Slug:** `WHATSAPP_GET_PHONE_NUMBER`

Retrieve detailed information about a specific WhatsApp Business phone number. Returns phone number details including verification status, quality rating, display number, verified business name, throughput limits, and webhook configuration. Use this to check phone number status, settings, and capabilities. To get available phone number IDs, first call WHATSAPP_GET_PHONE_NUMBERS.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated list of fields to retrieve. Available fields: id, display_phone_number, verified_name, code_verification_status, quality_rating, platform_type, throughput, webhook_configuration, last_onboarded_time. Default retrieves all available fields. |
| `phone_number_id` | string | Yes | The WhatsApp Business phone number ID (e.g., '901139066420489'). Get this from the WHATSAPP_GET_PHONE_NUMBERS action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get phone numbers

**Slug:** `WHATSAPP_GET_PHONE_NUMBERS`

Retrieve all phone numbers registered to your WhatsApp Business Account. Returns phone number IDs, display numbers, verification status, quality ratings, and messaging throughput limits. Use the phone number ID from the response to send WhatsApp messages via other API actions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of phone numbers to return per page (1-100). Use lower values for faster responses or when you only need a few numbers. |
| `waba_id` | string | No | Optional: WhatsApp Business Account ID to query. If not provided, uses the waba_id from your connection configuration. Only provide this if you need to override the configured WABA ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get template status

**Slug:** `WHATSAPP_GET_TEMPLATE_STATUS`

Get the status and details of a specific message template. This is useful for checking if a template has been approved, rejected, or is still pending review.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated list of fields to retrieve. Valid fields include: id, name, status, category, language, components, previous_category, parameter_format, quality_score, rejected_reason. If not specified, returns all default fields. |
| `template_id` | string | Yes | The ID of the template to check the status for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send contacts

**Slug:** `WHATSAPP_SEND_CONTACTS`

Send contacts WhatsApp number. Note: The message will be delivered to the recipient only if they have initiated a conversation first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contacts` | array | Yes | List of contacts to send. Sample input:      [         {             'addresses': [                 {                     'city': 'city name',                     'country': 'country name',                     'country_code': 'code',                     'state': "Contact's State",                     'street': "Contact's Street",                     'type': "Contact's Address Type",                     'zip': "Contact's Zip Code"                 }             ],             'birthday': 'birthday',             'emails': [                 {'email': 'email', 'type': 'HOME'},                 {'email': 'email', 'type': 'WORK'}             ],             'name': {                 'first_name': 'first name value',                 'formatted_name': 'formatted name value',                 'last_name': 'last name value',                 'suffix': 'suffix value'             },             'org': {                 'company': 'company name',                 'department': 'dep name',                 'title': 'title'             },             'phones': [                 {'phone': 'Phone number', 'wa_id': 'WA-ID value', 'type': 'MAIN'},                 {'phone': 'Phone number', 'type': 'HOME'},                 {'phone': 'Phone number', 'type': 'WORK'}             ],         }     ] |
| `to_number` | string | Yes | The phone number to send the contacts to, including the country code without the + sign. |
| `phone_number_id` | string | Yes | The phone number ID from which to send the contacts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send interactive buttons

**Slug:** `WHATSAPP_SEND_INTERACTIVE_BUTTONS`

Send an interactive button message with up to 3 reply buttons to a WhatsApp user. Interactive button messages allow recipients to quickly respond by tapping predefined buttons. Perfect for yes/no questions, multiple choice selections, quick actions, or call-to-action scenarios. IMPORTANT REQUIREMENTS: - The recipient must be a registered WhatsApp user - The recipient must have messaged your business first within the last 24 hours (WhatsApp's customer service window) - You can include 1-3 buttons per message - Each button can have a title (max 20 chars) and unique ID (max 256 chars) Use cases: Customer service menus, appointment confirmations, feedback collection, product selections.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `buttons` | array | Yes | List of 1-3 interactive buttons. Each button must have a unique ID and title. |
| `body_text` | string | Yes | Main message text explaining the purpose or question for the buttons (maximum 1024 characters). |
| `to_number` | string | Yes | Recipient's phone number in international format without the + sign (e.g., '14155552345' for a US number). The recipient must be a registered WhatsApp user and must have messaged your business within the last 24 hours. |
| `footer_text` | string | No | Optional footer text displayed at the bottom of the message, below the buttons (maximum 60 characters). |
| `header_text` | string | No | Optional header text displayed at the top of the message (maximum 60 characters). |
| `phone_number_id` | string | Yes | The WhatsApp Business phone number ID from which to send the message. Get this from the WHATSAPP_GET_PHONE_NUMBERS action. |
| `reply_to_message_id` | string | No | Optional message ID to reply to. Use this to create a threaded conversation by replying to a specific previous message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send interactive list

**Slug:** `WHATSAPP_SEND_INTERACTIVE_LIST`

Send an interactive list message to a WhatsApp number. List messages display a menu of options organized into sections. Users tap a button to view the list and select one option. Perfect for product catalogs, service menus, or guided workflows. Supports up to 10 sections with up to 10 items per section (100 total options). Note: Recipients must have messaged you first within the last 24 hours to receive this message.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sections` | array | Yes | Sections containing list items (maximum 10 sections, minimum 1 section). |
| `body_text` | string | Yes | Body text for the list message (up to 1024 characters). |
| `to_number` | string | Yes | The recipient's phone number in international format without the + sign (e.g., '15551234567' for a US number). Note: The recipient must have initiated a conversation with your WhatsApp Business account within the last 24 hours to receive this message. |
| `button_text` | string | Yes | Text for the list button (up to 20 characters). |
| `footer_text` | string | No | Footer text for the list message (up to 60 characters). |
| `header_text` | string | No | Header text for the list message (up to 60 characters). |
| `phone_number_id` | string | Yes | The Meta-assigned numeric ID for the WhatsApp Business phone number to send from. This is NOT the actual phone number itself - it is a numeric ID (e.g., '901139066420489') assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the 'id' field for each phone number. |
| `reply_to_message_id` | string | No | The ID of the message to reply to (optional). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send location

**Slug:** `WHATSAPP_SEND_LOCATION`

Send a location message with coordinates, name, and address to a WhatsApp user. This action allows you to share location information through WhatsApp Business API. The location message includes latitude/longitude coordinates, a location name, and address. Important: The recipient must have an active WhatsApp account. Additionally, you can only send free-form messages (like location messages) within the 24-hour customer service window after the recipient has initiated contact with your business. Outside this window, you must use approved message templates. Common error codes: - 133010: Recipient's phone number doesn't have a WhatsApp account - 131026: Message undeliverable (recipient may have blocked your business number) - 131047: Re-engagement message (outside 24-hour window, need to use template)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name or title of the location (e.g., 'San Francisco City Hall', 'Golden Gate Bridge'). This will be displayed to the recipient. |
| `address` | string | Yes | The full address of the location (e.g., '1 Dr Carlton B Goodlett Pl, San Francisco, CA 94102'). This provides context to the recipient about the location. |
| `latitude` | string | Yes | The latitude coordinate of the location in decimal degrees format (e.g., '37.7749' for San Francisco). Range: -90 to 90. |
| `longitude` | string | Yes | The longitude coordinate of the location in decimal degrees format (e.g., '-122.4194' for San Francisco). Range: -180 to 180. |
| `to_number` | string | Yes | The recipient's WhatsApp phone number in international format without the + sign or spaces (e.g., '14155238886' for US number). The recipient must have a WhatsApp account registered with this number. |
| `phone_number_id` | string | Yes | The WhatsApp Business phone number ID from which to send the location message. This is the ID of your WhatsApp Business phone number, not the phone number itself. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send media

**Slug:** `WHATSAPP_SEND_MEDIA`

Send a media message to a WhatsApp number. Note: The media will be delivered to the recipient only if they have texted first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link` | string | Yes | The publicly accessible HTTPS URL of the media file to send. The URL must be accessible by WhatsApp servers and serve the appropriate content-type header. For media uploads, use WHATSAPP_UPLOAD_MEDIA action to get a media ID and use WHATSAPP_SEND_MEDIA_BY_ID instead. |
| `caption` | string | No | Optional caption text to accompany the media (max 1024 characters). Only supported for 'image', 'video', and 'document' media types. Captions are NOT supported for 'audio' and 'sticker' types. |
| `to_number` | string | Yes | The phone number to send the media to, including the country code without the + sign. |
| `media_type` | string ("audio" | "document" | "image" | "sticker" | "video") | Yes | The type of media to send. Options: 'audio' (voice messages), 'document' (PDFs, docs), 'image' (PNG, JPG), 'sticker' (WebP animated stickers), 'video' (MP4 videos). Note: Only 'image', 'video', and 'document' types support captions. |
| `phone_number_id` | string | Yes | The Meta-assigned numeric ID for the WhatsApp Business phone number to send from. This is NOT the actual phone number itself - it is a numeric ID (e.g., '901139066420489') assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the 'id' field for each phone number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send media by

**Slug:** `WHATSAPP_SEND_MEDIA_BY_ID`

Send media using a media ID from previously uploaded media. This is more efficient than sending media by URL as the media is already on WhatsApp servers. Use upload_media action first to get the media ID. Note: The media will be delivered to the recipient only if they have texted first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `caption` | string | No | Caption for the media (not supported for audio and sticker). |
| `filename` | string | No | Filename for document media. |
| `media_id` | string | Yes | The media ID from uploaded media (use upload_media action to get this ID). |
| `to_number` | string | Yes | The phone number to send the media to, including the country code without the + sign. |
| `media_type` | string ("audio" | "document" | "image" | "sticker" | "video") | Yes | The type of media to send: audio, document, image, sticker, or video. |
| `phone_number_id` | string | Yes | The phone number ID from which to send the media. |
| `reply_to_message_id` | string | No | The ID of the message to reply to (optional). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send message

**Slug:** `WHATSAPP_SEND_MESSAGE`

Send a text message to a WhatsApp user. Important: The recipient phone number must be registered on WhatsApp and must have initiated a conversation with your business within the last 24 hours, OR you must use a template message (see WHATSAPP_SEND_TEMPLATE_MESSAGE) for the first message outside the 24-hour window. For test accounts, recipient numbers must be added to the test recipient list in Meta Business Suite before sending messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `text` | string | Yes | The text content of the message to send. Supports Unicode characters including emojis. Maximum length: 4096 characters. |
| `to_number` | string | Yes | The recipient's WhatsApp phone number in international format without the + sign (e.g., '14155551234' for a US number). The number must be registered on WhatsApp. |
| `message_id` | string | No | Optional: The WhatsApp message ID (wamid) to reply to. When provided, this message will be sent as a reply to the specified message, creating a quoted reply thread. Leave empty to send a regular message. |
| `preview_url` | boolean | No | Set to True to show a preview card for URLs in the message. When enabled, WhatsApp will fetch and display URL metadata (title, description, image) for the first URL in the message. Default: False. |
| `phone_number_id` | string | Yes | The Meta-assigned numeric ID for the WhatsApp Business phone number to send from. This is NOT the actual phone number itself - it is a numeric ID (e.g., '712594308615206') assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the 'id' field for each phone number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send template message

**Slug:** `WHATSAPP_SEND_TEMPLATE_MESSAGE`

Send a template message to a WhatsApp number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_number` | string | Yes | The phone number to send the template message to, including the country code without the + sign. |
| `components` | array | No | Template components with parameters to fill template variables. Use 'body' type with text parameters for simple variable substitution. |
| `language_code` | string ("af" | "sq" | "ar" | "ar_EG" | "ar_AE" | "ar_LB" | "ar_MA" | "ar_QA" | "az" | "be_BY" | "bn" | "bn_IN" | "bg" | "ca" | "zh_CN" | "zh_HK" | "zh_TW" | "hr" | "cs" | "da" | "prs_AF" | "nl" | "nl_BE" | "en" | "en_GB" | "en_US" | "en_AE" | "en_AU" | "en_CA" | "en_GH" | "en_IE" | "en_IN" | "en_JM" | "en_MY" | "en_NZ" | "en_QA" | "en_SG" | "en_UG" | "en_ZA" | "et" | "fil" | "fi" | "fr" | "fr_BE" | "fr_CA" | "fr_CH" | "fr_CI" | "fr_MA" | "ka" | "de" | "de_AT" | "de_CH" | "el" | "gu" | "ha" | "he" | "hi" | "hu" | "id" | "ga" | "it" | "ja" | "kn" | "kk" | "rw_RW" | "ko" | "ky_KG" | "lo" | "lv" | "lt" | "mk" | "ms" | "ml" | "mr" | "nb" | "ps_AF" | "fa" | "pl" | "pt_BR" | "pt_PT" | "pa" | "ro" | "ru" | "sr" | "si_LK" | "sk" | "sl" | "es" | "es_AR" | "es_CL" | "es_CO" | "es_CR" | "es_DO" | "es_EC" | "es_HN" | "es_MX" | "es_PA" | "es_PE" | "es_ES" | "es_UY" | "sw" | "sv" | "ta" | "te" | "th" | "tr" | "uk" | "ur" | "uz" | "vi" | "zu") | No | The language code for the template. |
| `template_name` | string | Yes | The name of the template to be sent. |
| `phone_number_id` | string | Yes | The phone number ID from which to send the template message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload media

**Slug:** `WHATSAPP_UPLOAD_MEDIA`

Upload media files (images, videos, audio, documents, stickers) to WhatsApp servers. The uploaded media gets a media ID that can be used in send_media or other messaging actions. Supported formats: - Images: JPEG, PNG (max 5MB) - Videos: MP4, 3GPP (max 16MB) - Audio: AAC, M4A, AMR, MP3, OGG (max 16MB) - Documents: PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX (max 100MB) - Stickers: WebP (max 500KB, 512x512 pixels)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media_type` | string ("image" | "video" | "audio" | "document" | "sticker") | Yes | Type of media being uploaded: image, video, audio, document, or sticker. |
| `file_to_upload` | object | Yes | Media file to upload to WhatsApp (max 16MB for most types, 100MB for videos). |
| `phone_number_id` | string | Yes | The phone number ID to upload media for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |


## Triggers

### Message Status Updated

**Slug:** `WHATSAPP_MESSAGE_STATUS_UPDATED_TRIGGER`

**Type:** poll

Triggers when a WhatsApp message status changes.

    IMPORTANT LIMITATION:
    WhatsApp Cloud API does not provide a native polling endpoint for message status.
    Status updates are ONLY delivered via webhooks in real-time. This trigger cannot
    directly poll the WhatsApp API for status updates.

    This trigger will return empty results as WhatsApp does not support this operation.
    To track message status updates, you must:
    1. Set up a webhook endpoint to receive status notifications from WhatsApp
    2. Store the webhook data in your own database
    3. Use a different mechanism to query your stored webhook data

    For more information, see:
    - https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks

#### Configuration

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `interval` | number | No | Periodic Interval to Check for Updates & Send a Trigger in Minutes |
| `max_results` | integer | No | Maximum number of status updates to retrieve in each poll (1-100). |
| `phone_number_id` | string | Yes | The Meta-assigned numeric ID for the WhatsApp Business phone number to monitor. This is NOT the actual phone number itself - it is a numeric ID (e.g., '712594308615206') assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the 'id' field for each phone number. |
| `status_filter` | string | No | Optional: Filter by specific status. Valid values: 'sent', 'delivered', 'read', 'failed'. Leave empty to monitor all status changes. |

#### Payload

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_type` | string | No | Type of event that occurred |
| `phone_number_id` | string | Yes | The phone number ID that sent the message |
| `status_update` | object | Yes | The message status update information |