WhatsApp Group Settings Update Webhook Examples

For the exhaustive schema-derived catalog, see all examples.

What it is

Handle WhatsApp group subject and description updates.

Before you begin

Create a public HTTPS endpoint in your application.
Configure a YCloud webhook endpoint for the event types you need.
Store the endpoint signing secret securely.
Make event processing idempotent.

How it works

YCloud sends an HTTP POST request when the event occurs. Verify the signature, durably record the event, return a 2xx response, and process slow work asynchronously.

Request

The scenarios below show requests delivered to your webhook URL. Treat the event id as the delivery identifier and use type to route the payload.

Response

Return a 2xx status after accepting the event.

HTTP/1.1 200 OK

For endpoint setup, signature validation, and retry behavior, see Configure webhooks.

Settings Updated

When WhatsApp group settings are successfully updated, you will receive a webhook with the following payload structure:

Request

{
  "id": "evt_group_settings_123",
  "type": "whatsapp.group.settings_update",
  "apiVersion": "v2",
  "createTime": "2026-05-13T00:00:00.000Z",
  "whatsappGroup": {
    "wabaId": "123456789012345",
    "field": "group_settings_update",
    "type": "group_settings_update",
    "requestId": "REQ_2",
    "status": "updated",
    "groupId": "Y2FwaV9ncm91cDpFWEFNUExFX0dST1VQX0lE",
    "subject": "Updated Purchase Inquiry",
    "description": "Updated group description.",
    "settings": [
      {
        "name": "group_subject",
        "text": "Updated Purchase Inquiry",
        "updateSuccessful": true
      },
      {
        "name": "group_description",
        "text": "Updated group description.",
        "updateSuccessful": true
      }
    ],
    "webhookTime": "2026-05-13T00:00:00.000Z"
  }
}

Response

Acknowledge the delivery after durably accepting the event.

HTTP/1.1 200 OK

Explanation

Route the event by type, deduplicate it by id, and move slow or failure-prone work to an asynchronous processor.

Settings Update Failed

When a WhatsApp group settings update fails or partially fails, you will receive a webhook with the following payload structure:

Request

{
  "id": "evt_group_settings_124",
  "type": "whatsapp.group.settings_update",
  "apiVersion": "v2",
  "createTime": "2026-05-13T00:00:00.000Z",
  "whatsappGroup": {
    "wabaId": "123456789012345",
    "field": "group_settings_update",
    "type": "group_settings_update",
    "requestId": "REQ_SETTINGS",
    "status": "failed",
    "groupId": "Y2FwaV9ncm91cDpFWEFNUExFX0dST1VQX0lE",
    "subject": "New subject",
    "settings": [
      {
        "name": "group_subject",
        "text": "New subject",
        "updateSuccessful": false,
        "errors": [
          {
            "code": 131201,
            "title": "Invalid group subject"
          }
        ]
      }
    ],
    "webhookTime": "2026-05-13T00:00:00.000Z"
  }
}

Response

Acknowledge the delivery after durably accepting the event.

HTTP/1.1 200 OK

Explanation

type: Always whatsapp.group.settings_update for group settings events
whatsappGroup: Contains the group settings update result details
- field: Always group_settings_update
- type: Always group_settings_update
- requestId: The request ID returned by the asynchronous group settings API operation
- status: The normalized settings update status, either updated or failed
- groupId: The WhatsApp group ID
- subject and description: The group text settings when present
- settings: Per-setting update results. name can be profile_picture, group_subject, or group_description
- settings[].updateSuccessful: Indicates whether the individual setting update succeeded
- settings[].errors: Errors returned by WhatsApp for the individual setting

Getting Started

Guides

Endpoints

Webhooks

WhatsApp Group Settings Update Webhook Examples

What it is

Before you begin

How it works

Request

Response

Settings Updated

Request

Response

Explanation

Settings Update Failed

Request

Response

Explanation

​What it is

​Before you begin

​How it works

​Request

​Response

​Settings Updated

​Request

​Response

​Explanation

​Settings Update Failed

​Request

​Response

​Explanation

What it is

Before you begin

How it works

Request

Response

Settings Updated

Request

Response

Explanation

Settings Update Failed

Request

Response

Explanation