Group Webhooks

This document describes the WhatsApp group event webhooks your system receives when groups are created and when participants join, leave, or are removed.
Use it to understand which events to expect and how to interpret the payload.


Event types you will receive

All group webhooks use the eventType field to describe what happened.

EventWhen you receive it
GROUP_CREATEDA new WhatsApp group was successfully created via the platform.
GROUP_PARTICIPANT_JOINEDA participant joined a group (accepted join, auto-joined, or was added).
GROUP_PARTICIPANT_LEFTA participant left a group on their own.
GROUP_PARTICIPANT_REMOVEDA participant was removed from a group by the business.


Group Created

Sent when a group is successfully created and stored.

Payload fields

FieldTypeDescription
groupIdstringClient custom group ID you passed when creating group.
groupNamestringGroup subject/name.
inviteLinkstringCurrent WhatsApp invite link for this group (if available).
groupCreatedAtstringISO 8601 timestamp when the group was created.

Sample payload

{
    "groupId": "support_group_001",
    "groupName": "New Support – Jan 2026",
    "inviteLink": "https://chat.whatsapp.com/SAMPLE_GROUP_INVITE",
    "groupCreatedAt": "2026-02-10T08:21:35.120Z"
}

Group participant joined

Sent when a participant becomes a member of the group (either added by the business or auto-approved).

Payload fields

FieldTypeDescription
groupIdstringClient custom group ID.
groupNamestringGroup subject/name.
customerPhonestringParticipant phone number (WhatsApp ID).
participantJoinedAtstringISO 8601 timestamp when the participant joined the group.

Sample payload

{
    "groupId": "support_group_001",
    "groupName": "New Support – Jan 2026",
    "customerPhone": "919999999999",
    "participantJoinedAt": "2026-02-10T08:25:10.000Z"
}

Group participant left

Sent when a participant leaves the group on their own (i.e. not removed).

Payload fields

FieldTypeDescription
groupIdstringClient custom group ID.
groupNamestringGroup subject/name.
customerPhonestringParticipant phone number.
participantLeftAtstringISO 8601 timestamp when the participant left the group.

Sample payload

{
    "groupId": "support_group_001",
    "groupName": "New Support – Jan 2026",
    "customerPhone": "919999999999",
    "participantLeftAt": "2026-02-11T10:02:45.430Z"
}

Group participant removed

Sent when a participant is removed from the group by the business or another participant.

Payload fields

FieldTypeDescription
groupIdstringClient custom group ID.
groupNamestringGroup subject/name.
customerPhonestringParticipant phone number.
participantRemovedAtstringISO 8601 timestamp when the participant was removed.

Sample payload

{
    "groupId": "support_group_001",
    "groupName": "New Support – Jan 2026",
    "customerPhone": "919999999999",
    "participantRemovedAt": "2026-02-11T10:05:12.000Z"
}

Quick reference: events by scenario

ScenarioEvent you receive
New group successfully createdGROUP_CREATED
Participant is added to a group or auto-joinsGROUP_PARTICIPANT_JOINED
Participant leaves the group by themselvesGROUP_PARTICIPANT_LEFT
Participant is removed from the groupGROUP_PARTICIPANT_REMOVED