Skip to main content

Group messages webhook reference | Developer Documentation

Group messages webhook reference

Updated: Nov 10, 2025
This reference describes trigger events and payload contents for the WhatsApp Business Account messages webhook for messages that are sent to a group, or received from a group.

Triggers

    A WhatsApp user or a business sends a message to a group.A WhatsApp user or a business receives a message within a group.

    Parameters

    Placeholder Description Example value
    <BUSINESS_DISPLAY_PHONE_NUMBER>
    String
    Business display phone number.
    15550783881
    <BUSINESS_PHONE_NUMBER_ID>
    String
    Business phone number ID.
    106540352242922
    <GROUP_ID>
    String
    The string identifier of a group made using the Groups API.
    This field shows when messages are sent, received, or read from a group.
    "Y2FwaV9ncm91cDoxNzA1NTU1MDEzOToxMjAzNjM0MDQ2OTQyMzM4MjAZD"
    <IDENTITY_KEY_HASH>
    String
    Identity key hash. Only included if you have enabled the identity change check feature.
    DF2lS5v2W6x=
    <MESSAGE_TEXT_BODY>
    String
    Text body of the message.
    What do you all think about this?
    <MESSAGE_TYPE>
    String
    The type of message being sent. Will change depending on the message sent to the group.
    Currently, the Groups API supports:
      TextMediaText-based templatesMedia-based templates
      text
      <WHATSAPP_BUSINESS_ACCOUNT_ID>
      String
      WhatsApp Business Account ID.
      102290129340398
      <WHATSAPP_MESSAGE_ID>
      String
      WhatsApp message ID.
      wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=
      <WEBHOOK_TRIGGER_TIMESTAMP>
      String
      Unix timestamp indicating when the webhook was triggered.
      1739321024
      <WHATSAPP_USER_PHONE_NUMBER>
      String
      WhatsApp user phone number. This is the same value returned by the API as the input value when sending a message to a WhatsApp user. Note that a WhatsApp user's phone number and ID may not always match.
      +16505551234
      <WHATSAPP_USER_PROFILE_NAME>
      String
      WhatsApp user's name as it appears in their profile in the WhatsApp client.
      Sheena Nelson
      <WHATSAPP_USER_ID>
      String
      WhatsApp user ID. Note that a WhatsApp user's ID and phone number may not always match.
      16505551234

      No comments to display

      Back to top