whatsapp.call.transcription.updated

Use whatsapp.call.transcription.updated to handle this event at your webhook endpoint.

Triggers

Occurs when an API-sourced WhatsApp call transcription becomes available or permanently fails. Subscribe to whatsapp.call.transcription.updated when you configure your webhook endpoint. This event reports a terminal state for an API-sourced call media asset. Use mediaAssetId with the call media download API when status is AVAILABLE. Inspect error when status is FAILED.

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.

{
  "id": "<ID>",
  "type": "whatsapp.call.transcription.updated",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "callingTranscription": {
    "wacid": "<WACID>",
    "phoneId": "<PHONE_ID>",
    "mediaAssetId": "<MEDIA_ASSET_ID>",
    "status": "<STATUS>",
    "error": {
      "code": "<CODE>",
      "retryable": "<RETRYABLE_VALUE>"
    }
  }
}

Parameters

Validate the YCloud-Signature HTTP header before you process the JSON body. See signature validation.

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.call.transcription.updated`.
`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. e.g., `2022-06-01T12:00:00.000Z`.

Event payload

Parameter	Type	Required	Description
`callingTranscription`	object	No	Event-specific `callingTranscription` 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.

callingTranscription

Parameter	Type	Required	Description
`wacid`	string	Yes	WhatsApp call ID.
`phoneId`	string	Yes	WhatsApp business phone number ID used for authorized-asset delivery.
`mediaAssetId`	string	Yes	YCloud media asset ID used with the call media download API.
`status`	string	Yes	Values: `AVAILABLE`, `FAILED`.
`error`	object	No	Present only when `status` is `FAILED`.

callingTranscription.error

Parameter	Type	Required	Description
`code`	string	Yes	Stable failure code.
`retryable`	boolean	Yes	Whether retrying the upstream media operation may succeed.

Example

The following JSON is the body delivered to your receiver. IDs, phone numbers, and other account values are illustrative. Example payload when an API-sourced call transcription permanently fails

{
  "id": "evt_call_transcription_01JZ8K5A9C4D7E0F3G6H9J2K5M",
  "type": "whatsapp.call.transcription.updated",
  "apiVersion": "v2",
  "createTime": "2026-08-04T08:01:00.000Z",
  "callingTranscription": {
    "wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABE",
    "phoneId": "461269257068832",
    "mediaAssetId": "66b1f0d9e4b05c2d8f1a3b48",
    "status": "FAILED",
    "error": {
      "code": "CALLING_TRANSCRIPTION_PROCESSING_FAILED",
      "retryable": false
    }
  }
}

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

HTTP/1.1 200 OK

For scenario walkthroughs, see annotated examples.

Getting Started

Guides

Endpoints

Webhook reference

whatsapp.call.transcription.updated

Triggers

Syntax

Parameters

Event envelope

Event payload

callingTranscription

Example

​Triggers

​Syntax

​Parameters

​Event envelope

​Event payload

​callingTranscription

​Example

Triggers

Syntax

Parameters

Event envelope

Event payload

callingTranscription

Example