This document provides examples of WhatsApp group status webhook payloads that your application may receive when a group is suspended or the suspension is cleared.
Group Suspended
When a WhatsApp group is suspended, you will receive a webhook with the following payload structure:
{
"id": "evt_group_status_123",
"type": "whatsapp.group.status_update",
"apiVersion": "v2",
"createTime": "2026-05-13T00:00:00.000Z",
"whatsappGroup": {
"tenantId": "tenant-id",
"wabaId": "123456789012345",
"field": "group_status_update",
"type": "group_suspend",
"status": "suspended",
"groupId": "[email protected]",
"webhookTime": "2026-05-13T00:00:00.000Z"
}
}Group Suspension Cleared
When a WhatsApp group suspension is cleared, you will receive a webhook with the following payload structure:
{
"id": "evt_group_status_124",
"type": "whatsapp.group.status_update",
"apiVersion": "v2",
"createTime": "2026-05-13T00:00:00.000Z",
"whatsappGroup": {
"tenantId": "tenant-id",
"wabaId": "123456789012345",
"field": "group_status_update",
"type": "group_suspend_cleared",
"status": "suspend_cleared",
"groupId": "[email protected]",
"webhookTime": "2026-05-13T00:00:00.000Z"
}
}Payload Description
- type: Always
whatsapp.group.status_updatefor group suspension status events - whatsappGroup: Contains the group suspension status details
- field: Always
group_status_update - type: The status event type, either
group_suspendorgroup_suspend_cleared - status: The normalized group status, either
suspendedorsuspend_cleared - groupId: The WhatsApp group ID
- webhookTime: The time at which WhatsApp triggered this webhook
- field: Always
