> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# whatsapp.flow.status_change

> Occurs when a WhatsApp flow status is updated.

Use `whatsapp.flow.status_change` to handle this event at your webhook endpoint.

## Triggers

Occurs when a WhatsApp flow status is updated.

Subscribe to `whatsapp.flow.status_change` when you [configure your webhook endpoint](https://docs.ycloud.com/en/api-reference/guides/api-fundamentals/configure-webhooks.md).

## Syntax

YCloud sends an HTTP `POST` request to your configured webhook URL. The following shape shows one payload variant. Angle-bracket values are placeholders; their types are listed under **Parameters**. Optional fields and other variants are described below.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "type": "whatsapp.flow.status_change",
  "id": "<ID>",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "flowChanges": {
    "flowId": "<FLOW_ID>",
    "wabaId": "<WABA_ID>",
    "message": "<MESSAGE>",
    "oldStatus": "<OLD_STATUS>",
    "newStatus": "<NEW_STATUS>"
  }
}
```

## Parameters

Validate the `YCloud-Signature` HTTP header before you process the JSON body. See [signature validation](https://docs.ycloud.com/en/api-reference/guides/api-fundamentals/configure-webhooks.md).

### Event envelope

| Parameter | Type | Required | Description |
| - | - | - | - |
| `id` | string | Yes | Unique ID for the event. Minimum length: `6`. Maximum length: `128`. |
| `type` | string | Yes | Always `whatsapp.flow.status_change`. |
| `apiVersion` | string | Yes | The API version used to render this event. |
| `createTime` | string (date-time) | Yes | The time at which this event was created, formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). e.g., `2022-06-01T12:00:00.000Z`. |

### Event payload

| Parameter | Type | Required | Description |
| - | - | - | - |
| `flowChanges` | object | No | Event-specific `flowChanges` payload. |

The four common envelope fields are required. Payload fields depend on the event variant. In each object table, **Required** applies when its parent object is present. Optional fields can be omitted; a sample does not make a field required.

#### flowChanges

| Parameter | Type | Required | Description |
| - | - | - | - |
| `flowId` | string | Yes | The unique ID of the Flow. |
| `wabaId` | string | Yes | WhatsApp Business Account ID. |
| `message` | string | No | The message ID of the flow status change. |
| `oldStatus` | string | No | The old status of the flow. |
| `newStatus` | string | Yes | The new status of the flow. |

## Example

The following JSON is the body delivered to your receiver. IDs, phone numbers, and other account values are illustrative.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "type": "whatsapp.flow.status_change",
  "id": "evt_1234567890abcdef",
  "apiVersion": "v2",
  "createTime": "2025-09-11T07:24:52.000Z",
  "flowChanges": {
    "flowId": "1097420589034000",
    "wabaId": "123456789012345",
    "message": "Flow Webhook 3 changed status from DRAFT to PUBLISHED",
    "oldStatus": "DRAFT",
    "newStatus": "PUBLISHED"
  }
}
```

After verifying the signature and durably accepting the event, return a `2xx` response. Process slow work asynchronously.

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```

For scenario walkthroughs, see [annotated examples](https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-flow-webhook-examples).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.