Groups

WhatsApp Cloud API Webhooks for Groups

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 the WebHook documentation. We mentioned more about the events here: Mode setting

New group

You have been added to a group, or a group has been created with you.

{
  "groups": [
    {
      "id": "[e-mail]",
      "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

{
  "messages": [
    {
      "id": ".juaBlBX6cgpT8UKLNnVEw-kh8Bq53B6TdEoQ-E8JdK1c",
      "from_me": false,
      "type": "text",
      "chat_id": "[e-mail]",
      "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

{
  "groups_participants": [
    {
      "group_id": "[e-mail]",
      "participants": [
        "61280155346"
      ],
      "action": "add"
    }
  ],
  "event": {
    "type": "groups",
    "event": "put"
  },
  "channel_id": "MANTIS-M72HC"
}

Participant removed

{
  "groups_participants": [
    {
      "group_id": "[e-mail]",
      "participants": [
        "61280155346"
      ],
      "action": "remove"
    }
  ],
  "event": {
    "type": "groups",
    "event": "put"
  },
  "channel_id": "MANTIS-M72HC"
}

Participant became an admin

{
  "groups_participants": [
    {
      "group_id": "[e-mail]",
      "participants": [
        "61371989950"
      ],
      "action": "promote"
    }
  ],
  "event": {
    "type": "groups",
    "event": "put"
  },
  "channel_id": "MANTIS-M72HC"
}

The participant is no longer an administrator

{
  "groups_participants": [
    {
      "group_id": "[e-mail]",
      "participants": [
        "61371989950"
      ],
      "action": "demote"
    }
  ],
  "event": {
    "type": "groups",
    "event": "put"
  },
  "channel_id": "MANTIS-M72HC"
}

New request to join a group

{
  "groups_participants": [
    {
      "group_id": "[e-mail]",
      "participants": [
        "61371989850"
      ],
      "action": "request"
    }
  ],
  "event": {
    "type": "groups",
    "event": "put"
  },
  "channel_id": "MANTIS-PF298"
}