Help Desk
  • Getting Started
    • ๐Ÿ™ŒWelcome to Whapi.Cloud
    • ๐Ÿ’ฐPricing
    • โ˜•Partners
    • ๐Ÿš€Getting started
    • ๐Ÿ‘จโ€๐Ÿ’ปAPI Docs
      • Developer hubs
      • Swagger environment
      • Postman collection
  • Sending
    • Introduction
    • Send text message
      • Whatsapp API send message PHP
      • Whatsapp API send message Python
      • Whatsapp API send message Node JS
      • Whatsapp API send message ะก#
      • Whatsapp API send message Java
      • API integration with VB6
      • Whatsapp API send message GO (Golang)
    • Send video, audio, image, document
      • How to send file from your local computer using the API
    • Send Group message
    • Send post to WhatsApp Channel
    • Send message with Buttons
    • Send Emoji
    • Overview of other methods for sending
      • Send Voice message
      • Send contact (vCard)
      • Send message reactions
  • Receiving
    • Introduction
    • Webhooks
      • Our webhooks (Tracked events)
      • Where to Find the Webhook URL?
      • Set the webhook link to the channel
      • Detailed webhook settings
      • How to check the webhook?
      • Incoming webhooks format
        • Incoming message
        • Sent message
        • Chats
          • How to Track Chat Labels via Webhook
        • Groups
        • Communities
        • Contacts
        • Account and device status
        • Other
          • Calls
          • Presences
          • Labels
          • Views of stories (statuses)
          • Story (status) from your contacts
      • Receive messages
        • Receive WhatsApp messages using PHP
        • Receive WhatsApp messages using Node js
        • Receive WhatsApp messages using Python
    • HTTP API
      • How to retrieve files
      • Retrieve a Specific User's Chat History
      • Get a full-size picture in the response
      • Get order items
      • Get a profile picture of a chat or user
    • File expiration period
  • Groups
    • Send Group message
      • Mentioning all participants in a WhatsApp group
    • Get list of group members
    • Add new member to Group
  • Channels
    • Send post to WhatsApp Channel
    • Get messages from Channels
    • Get votes from polls in the Channel
  • Communities
    • Introduction
    • Create a community
    • Add a member to a community
    • Send announcement
    • Get info on community participants
    • Add a group / Exclude a group from the community
  • Account
    • Setting "Auto Download"
    • Customizable Webhook Headers
    • How to find out the IP channel
    • How to Delete a Channel
    • Add Business Info to Invoice
  • Source code
    • WhatsApp ChatBot
      • WhatsApp Python Bot
      • WhatsApp PHP Bot
      • WhatsApp Node JS Bot
      • WhatsApp Java Bot
    • WhatsApp API Google Sheets
    • WhatsApp Phone Number Checker
    • Request Distributor (Balancer)
  • FAQ
    • Does WhatsApp API work with the phone turned off?
    • Chat ID. What is it and how to get it?
    • Why do I see status "pending" after sending message?
    • How to send a paragraph (line break)
    • Inactive Links in WhatsApp Messages
    • WhatsApp Text Formatting
    • Checking if the number has Whatsapp
    • Specifics of sending messages to numbers of different countries
    • Current status of Buttons on WhatsApp
    • Why aren't participants being added to the group?
  • Hints
    • Android Emulators
    • Virtual Numbers for WhatsApp
    • How to use polls as buttons?
    • How to check who blocked you in Whatsapp?
    • Setting up a WhatsApp proxy
  • Integrations
    • Make.com
      • Ready-Made Scenarios
        • WhatsApp & Whisper API: Voice-to-Text Integration
        • Automated WhatsApp Group Message Forwarding in Make.com
      • Request Scenario Setup
    • Pabbly Connect
    • Google Contacts
    • DialogFlow
    • n8n
  • Tools
    • WhatsApp Number Checker
    • Automatic warm-up module
    • WhatsApp Activity Safety Meter
    • Residential Proxies from Whapi.Cloud
  • Troubleshooting
    • Couldn't Link Device โ€“ WhatsApp QR Code or Pairing Code Fails
    • Channel status โ€œSYNC_ERRORโ€
    • Not getting a READ status on webhook
    • 429 (Too Many Requests) - Soft Ban
    • โ€œWaiting for this message. This may take a whileโ€ โ€“ WhatsApp Message Error
    • Missing push notifications after connecting to API
  • Blocking
    • How to not get Banned?
    • How to do mailings without the risk of being blocked?
    • If My Number Is Banned, Can It Be Restored?
    • Unlocking Your WhatsApp Number
    • Connecting a New WhatsApp Number After a Ban: Steps and Recommendations
    • Warming Up New Phone Numbers for WhatsApp API
  • Partner Documentation
    • Introduction
    • Partner Dashboard Overview
    • Partner Program Guidelines
      • Workflow: Step-by-Step
      • Billing for Partners
      • Allocating Days to Customer Channels: Best Practices & Guide
      • Interface for channel management
    • Partner Documentation
      • Channel creation
      • Changing channel mode
      • Channel extension
      • Channel deletion
      • Getting the list of channels
      • Notices of end of days on balance
Powered by GitBook
On this page
  • New group
  • New message in the group
  • A new member has been added
  • Participant removed
  • Participant became an admin
  • The participant is no longer an administrator
  • New request to join a group
  • Group name changed
  • Changed group profile picture
  • Changing a participant's number

Was this helpful?

  1. Receiving
  2. Webhooks
  3. Incoming webhooks format

Groups

WhatsApp Cloud API Webhooks for Groups

PreviousHow to Track Chat Labels via WebhookNextCommunities

Last updated 10 days ago

Was this helpful?

The groups array contains all groups that were sent to the webhook URL. Sent on event "groups.post".

The groups participants event array contains all groups participants event that were sent to the webhook URL. Sent on event "groups.put"

The groups updates array contains all groups updates that were sent to the webhook URL. Sent on event "groups.patch"

You can find more details about all parameters and their types in . We mentioned more about the events here:

New group

You have been added to a group, or a group has been created with you. Use the groups.post setting to get this webhook.

{
  "groups": [
    {
      "id": "120363271212442249@g.us",
      "name": "Group name! ๐Ÿ˜ƒ",
      "type": "group",
      "timestamp": 1713791253,
      "participants": [
        {
          "id": "61371989950",
          "rank": "member"
        },
        {
          "id": "919984351847",
          "rank": "creator"
        }
      ],
      "name_at": 1713791253,
      "created_at": 1713791253,
      "created_by": "919984351847"
    }
  ],
  "event": {
    "type": "groups",
    "event": "post"
  },
  "channel_id": "MANTIS-M72HC"
}

New message in the group

Use the messages.post setting to get this webhook.

{
  "messages": [
    {
      "id": ".juaBlBX6cgpT8UKLNnVEw-kh8Bq53B6TdEoQ-E8JdK1c",
      "from_me": false,
      "type": "text",
      "chat_id": "120363271212442249@g.us",
      "timestamp": 1713791337,
      "source": "mobile",
      "text": {
        "body": "Hey, what's up"
      },
      "from": "919984351847",
      "from_name": "Gerald"
    }
  ],
  "event": {
    "type": "messages",
    "event": "post"
  },
  "channel_id": "MANTIS-M72HC"
}

A new member has been added

Use the groups.put setting to get this webhook.

{
  "groups_participants": [
    {
      "group_id": "120363271212442249@g.us",
      "participants": [
        "61280155346"
      ],
      "action": "add"
    }
  ],
  "event": {
    "type": "groups",
    "event": "put"
  },
  "channel_id": "MANTIS-M72HC"
}

Participant removed

Use the groups.put setting to get this webhook.

{
  "groups_participants": [
    {
      "group_id": "120363271212442249@g.us",
      "participants": [
        "61280155346"
      ],
      "action": "remove"
    }
  ],
  "event": {
    "type": "groups",
    "event": "put"
  },
  "channel_id": "MANTIS-M72HC"
}

Participant became an admin

Use the groups.put setting to get this webhook.

{
  "groups_participants": [
    {
      "group_id": "120363271212442249@g.us",
      "participants": [
        "61371989950"
      ],
      "action": "promote"
    }
  ],
  "event": {
    "type": "groups",
    "event": "put"
  },
  "channel_id": "MANTIS-M72HC"
}

The participant is no longer an administrator

Use the groups.put setting to get this webhook.

{
  "groups_participants": [
    {
      "group_id": "120363271212442249@g.us",
      "participants": [
        "61371989950"
      ],
      "action": "demote"
    }
  ],
  "event": {
    "type": "groups",
    "event": "put"
  },
  "channel_id": "MANTIS-M72HC"
}

New request to join a group

Use the groups.put setting to get this webhook.

{
  "groups_participants": [
    {
      "group_id": "120363471232412449@g.us",
      "participants": [
        "61371989850"
      ],
      "action": "request"
    }
  ],
  "event": {
    "type": "groups",
    "event": "put"
  },
  "channel_id": "MANTIS-M72HC"
}

Group name changed

Use the groups.patch setting to get this webhook.

{
  "groups_updates": [
    {
      "before_update": {
        "id": "120363498775936551@g.us",
        "name": "Our journey โ›ฐ๏ธ",
        "type": "group",
        "participants": [
          {
            "id": "61371989950",
            "rank": "member"
          },
          {
            "id": "919984351847",
            "rank": "creator"
          }
        ],
        "name_at": 1747661405,
        "created_at": 1743410397,
        "created_by": "919984351847",
        "adminAddMemberMode": true
      },
      "after_update": {
        "id": "120363498775936551@g.us",
        "name": "Good trip โ›ฐ๏ธ๐Ÿ”๏ธ",
        "type": "group",
        "participants": [
          {
            "id": "61371989950",
            "rank": "member"
          },
          {
            "id": "919984351847",
            "rank": "creator"
          }
        ],
        "name_at": 1747661405,
        "created_at": 1743410397,
        "created_by": "919984351847",
        "adminAddMemberMode": true
      },
      "changes": [
        "name"
      ]
    }
  ],
  "event": {
    "type": "groups",
    "event": "patch"
  },
  "channel_id": "MANTIS-M72HC"
}

Changed group profile picture

Use the groups.patch setting to get this webhook.

{
  "groups_updates": [
    {
      "before_update": {
        "id": "120363498775936551@g.us",
        "name": "Our journey โ›ฐ๏ธ",
        "type": "group",
        "timestamp": 1747391325,
        "chat_pic": "changed",
        "not_spam": true,
        "last_message": {
          "id": "EFgJZBk-kusBq53fm7NK5g-E8JdK1c",
          "type": "system",
          "subtype": "group_change_icon",
          "chat_id": "120363498775936551@g.us",
          "from": "919984351847",
          "from_me": false,
          "source": "system",
          "timestamp": 1747661806
        },
        "participants": [
          {
            "id": "61371989950",
            "rank": "member"
          },
          {
            "id": "919984351847",
            "rank": "creator"
          }
        ],
        "name_at": 1747661405,
        "created_at": 1743410397,
        "created_by": "919984351847",
        "adminAddMemberMode": true
      },
      "after_update": {
        "id": "120363498775936551@g.us",
        "name": "Our journey โ›ฐ๏ธ",
        "type": "group",
        "timestamp": 1747391325,
        "chat_pic": "https://pps.whatsapp.net/v/t62.24694-24/491878509_1329198295045131_8243456031832458554_n.jpg?stp=dst-jpg_s96x96_tt6&ccb=11-4&oh=01_Q5Aa1gEq-WZYAgjAZMZd6UEZFN30lEsxoha3JZH0bs07_p7F7Q&oe=683838BA&_nc_sid=5e03e0&_nc_cat=111",
        "chat_pic_full": "https://pps.whatsapp.net/v/t62.24694-24/491878509_1329198295045131_8243456031832458554_n.jpg?ccb=11-4&oh=01_Q5Aa1gEQcMhEWHOOb7XuktZhPH4l-uN1CcLGU46zZsWMt90VGQ&oe=683838BA&_nc_sid=5e03e0&_nc_cat=111",
        "not_spam": true,
        "last_message": {
          "id": "EFgJZBk-kusBq53fm7NK5g-E8JdK1c",
          "type": "system",
          "subtype": "group_change_icon",
          "chat_id": "120363498775936551@g.us",
          "from": "919984351847",
          "from_me": false,
          "source": "system",
          "timestamp": 1747661806
        },
        "participants": [
          {
            "id": "61371989950",
            "rank": "member"
          },
          {
            "id": "919984351847",
            "rank": "creator"
          }
        ],
        "name_at": 1747661405,
        "created_at": 1743410397,
        "created_by": "919984351847",
        "adminAddMemberMode": true
      },
      "changes": [
        "chat_pic",
        "chat_pic_full"
      ]
    }
  ],
  "event": {
    "type": "groups",
    "event": "patch"
  },
  "channel_id": "MANTIS-M72HC"
}

Changing a participant's number

Technical note: Currently, if a member in your group changes their phone number, the system will trigger the same event as if a new member was added to the group. Please keep this in mind. We will update this page if in the future we can distinguish between new members and number updates for existing members.

the WebHook documentation
Mode setting