Callback Payloads Examples

Group Lifecycle Updates

Group Lifecycle Updates notify your application when a WhatsApp group is created or deleted, including whether the operation was successful or failed.

Create Group - Triggered when a group is successfully created.

{
  "group_id": "Y2FwaV9ncm91cDo5MTc5NjE3MzI4MDY6MTIwMzYzNDI2NzcyNjAXXXXX",
  "type": "group_create",
  "request_id": "F34DEF7603396EE72F9010301874XXXX",
  "subject": "Test Group",
  "invite_link": "https://chat.whatsapp.com/IbiHwpOJ6Uc6ep0CG0xxxx"
}

Create Group Failed - Triggered when a group creation request fails.

{
  "group_id": "Y2FwaV9ncm91cDo5MTc5NjE3MzI4MDY6MTIwMzYzNDIyOTQ0MTUXXXXX",
  "type": "group_create",
  "request_id": "9QYTENS89223HUXXXX",
  "subject": "Test Group",
  "invite_link": ""
}

Group Delete - Triggered when a group is successfully deleted.

{
  "group_id": "Y2FwaV9ncm91cDo5MTc5NjE3MzI4MDY6MTIwMzYzNDI2NzcyNjAXXXXX",
  "type": "group_delete",
  "request_id": "F543727FF3AC85E0728C3AE60006XXXX",
  "subject": "null",
  "invite_link": ""
}

Group Delete Failed - Triggered when a group deletion request fails.

{
  "group_id": "Y2FwaV9ncm91cDo5MTc5NjE3MzI4MDY6MTIwMzYzNDIyOTQ0MTUXXXXX",
  "type": "group_delete",
  "request_id": "F543727FF3AC85E0728C3AE60006XXXX",
  "subject": "null",
  "invite_link": ""
}

Group Participant Update

Group Participant Updates notify your application when participants are added to or removed from a WhatsApp group.

Participant joined the Group - Triggered when one or more participants are added to the group.

1. {
     "group_id": "Y2FwaV9ncm91cDo5MTc5NjE3MzI4MDY6MTIwMzYzNDA1NzQwNzMXXXXX",
     "added_participants": ["918177871XXX"],  
     "removed_participants": null,
     "initiated_by": ""
   }

Participant left the Group - Triggered when a participant leaves the group voluntarily.

{
  "group_id": "Y2FwaV9ncm91cDo5MTc5NjE3MzI4MDY6MTIwMzYzNDI2NzcyNjAXXXXX",
  "added_participants": null,
  "removed_participants": ["919360949XXX"],
  "initiated_by": "participant"
}

Participant removed by business - Triggered when one or more participants are removed from the group by the business.

{
  "group_id": "Y2FwaV9ncm91cDo5MTc5NjE3MzI4MDY6MTIwMzYzNDA1NzQwNzM4XXXXX",
  "added_participants": null,
  "removed_participants": [
    "917892218XXX",
    "918177871XXX",
    "919632005XXX"
  ],
  "initiated_by": "business"
}

Group Status Update

Group Status Updates notify your application when the status of a WhatsApp group changes due to suspension or when a previous suspension is cleared.

Group Suspended -Triggered when a group is suspended.

{
  "group_id": "Y2FwaV9ncm91cDo5MTc5NjE3MzI4MDY6MTIwMzYzNDIyOTQ0MTUXXXXX",
  "type": "group_suspend"
}

Group Suspension cleared - Triggered when the suspension on a group is cleared and the group is no longer suspended.
```
{
  "group_id": "Y2FwaV9ncm91cDo5MTc5NjE3MzI4MDY6MTIwMzYzNDIyOTQ0MTUXXXXX",
  "type": "group_suspend_cleared"
}
```