> ## 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.
# Ejemplos de payloads de webhook
> Explora ejemplos de payloads para cada tipo de evento de webhook.
## Qué es
Este catálogo cubre los 43 tipos de eventos de webhook en la especificación OpenAPI y conserva cada ejemplo de payload con nombre.
## Cómo funciona
Elige un evento por su `type` exacto, expande un ejemplo y usa el payload para probar el enrutamiento, la deserialización, la idempotencia y el procesamiento asíncrono en tu receptor de webhooks.
## Solicitud
Cada ejemplo es el cuerpo JSON de una solicitud HTTP `POST` enviada por YCloud. La solicitud también incluye un encabezado `YCloud-Signature` que debes validar antes de confiar en el payload.
## Respuesta
Devuelve una respuesta `2xx` una vez que tu aplicación haya aceptado el evento de forma duradera.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
Para conocer los requisitos previos, el comportamiento de los desencadenadores, las explicaciones del ciclo de vida y los escenarios anotados, consulta los [tutoriales paso a paso de ejemplos de webhooks](/es/api-reference/guides/examples/webhook-examples/overview).
## Catálogo de payloads
Almacena el texto de whatsappMessage.text.body. id y wamid vinculan los eventos de estado posteriores.
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_example_echo_text",
"type": "whatsapp.echo_message.created",
"apiVersion": "v2",
"createTime": "2026-09-09T02:00:00.000Z",
"whatsappMessage": {
"id": "MESSAGE_ID",
"wamid": "wamid.EXAMPLE",
"wabaId": "WABA_ID",
"from": "+12025550123",
"to": "+12025550124",
"recipientUserId": "GB.898232076600896",
"type": "text",
"text": {
"body": "Hello! How can I help you?"
},
"status": "sent",
"createTime": "2026-09-09T02:00:00.000Z",
"sendTime": "2026-09-09T02:00:00.000Z"
}
}
```
El contenido del mensaje varía según el tipo. Trata los ID de medios como referencias del proveedor, no como URL de descarga públicas.
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_example_echo_image",
"type": "whatsapp.echo_message.created",
"apiVersion": "v2",
"createTime": "2026-09-09T02:00:00.000Z",
"whatsappMessage": {
"id": "IMAGE_MESSAGE_ID",
"wamid": "wamid.IMAGE_EXAMPLE",
"wabaId": "WABA_ID",
"from": "+12025550123",
"to": "+12025550124",
"recipientUserId": "GB.898232076600896",
"type": "image",
"image": {
"id": "MEDIA_ID",
"mime_type": "image/jpeg"
},
"status": "sent",
"createTime": "2026-09-09T02:00:00.000Z",
"sendTime": "2026-09-09T02:00:00.000Z"
}
}
```
Correlaciona con el evento creado mediante id o wamid. Los eventos actualizados omiten el contenido y el tipo del mensaje.
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_example_echo_delivered",
"type": "whatsapp.echo_message.updated",
"apiVersion": "v2",
"createTime": "2026-09-09T02:00:03.000Z",
"whatsappMessage": {
"id": "MESSAGE_ID",
"wamid": "wamid.EXAMPLE",
"wabaId": "WABA_ID",
"from": "+12025550123",
"to": "+12025550124",
"recipientUserId": "GB.898232076600896",
"status": "delivered",
"updateTime": "2026-09-09T02:00:01.000Z",
"deliverTime": "2026-09-09T02:00:01.000Z"
}
}
```
Correlaciona con el evento creado mediante id o wamid. Los eventos actualizados omiten el contenido y el tipo del mensaje.
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_example_echo_read",
"type": "whatsapp.echo_message.updated",
"apiVersion": "v2",
"createTime": "2026-09-09T02:00:03.000Z",
"whatsappMessage": {
"id": "MESSAGE_ID",
"wamid": "wamid.EXAMPLE",
"wabaId": "WABA_ID",
"from": "+12025550123",
"to": "+12025550124",
"recipientUserId": "GB.898232076600896",
"status": "read",
"updateTime": "2026-09-09T02:00:02.000Z",
"readTime": "2026-09-09T02:00:02.000Z"
}
}
```
Puede llegar un estado de origen de menor rango después de haber sido leído. Registra el evento sin degradar el estado actual de tu mensaje.
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_example_echo_sent",
"type": "whatsapp.echo_message.updated",
"apiVersion": "v2",
"createTime": "2026-09-09T02:00:03.000Z",
"whatsappMessage": {
"id": "MESSAGE_ID",
"wamid": "wamid.EXAMPLE",
"wabaId": "WABA_ID",
"from": "+12025550123",
"to": "+12025550124",
"recipientUserId": "GB.898232076600896",
"status": "sent",
"updateTime": "2026-09-09T02:00:00.000Z",
"sendTime": "2026-09-09T02:00:00.000Z"
}
}
```
Este es un mensaje fallido independiente, no una transición desde leído. Las actualizaciones fallidas incluyen detalles del error de origen cuando están disponibles.
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_example_echo_failed",
"type": "whatsapp.echo_message.updated",
"apiVersion": "v2",
"createTime": "2026-09-09T02:00:03.000Z",
"whatsappMessage": {
"id": "FAILED_MESSAGE_ID",
"wamid": "wamid.FAILED_EXAMPLE",
"wabaId": "WABA_ID",
"from": "+12025550123",
"to": "+12025550124",
"recipientUserId": "GB.898232076600896",
"status": "failed",
"errorCode": "131000",
"errorMessage": "Provider failure",
"updateTime": "2026-09-09T02:00:03.000Z"
}
}
```
APP\_CONTROL\_TAKEN informa la transferencia de control, no una asignación de empleado de Inbox ni la entrega de un mensaje de traspaso personalizado. actor es el ID de la app propietaria anterior en este ejemplo.
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_example_agent_handover",
"type": "whatsapp.meta_business_agent.handover.updated",
"apiVersion": "v2",
"createTime": "2026-09-09T02:00:04.000Z",
"whatsappMetaBusinessAgent": {
"agentId": "00000000-0000-4000-8000-000000000001",
"metaAgentId": "META_AGENT_ID",
"phoneNumberId": "PHONE_NUMBER_ID",
"wabaId": "WABA_ID",
"consumerPhoneNumber": "+12025550124",
"controlState": "APP_CONTROL_TAKEN",
"actor": "PREVIOUS_OWNER_APP_ID",
"reason": "customer_request",
"timestamp": 1788919204000
}
}
```
Ejemplo de payload cuando se modifican los atributos de un contacto
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "contact.attributes_changed",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"contactAttributesChanged": {
"id": "1824266594102064128",
"updateTime": "2024-01-01T12:00:00.000Z",
"changedAttributes": {
"remark_name": {
"oldValue": "Standard customer",
"newValue": "Priority customer"
},
"email": {
"oldValue": "john.doe@example.com",
"newValue": "johnny.doe@example.com"
},
"tags": {
"oldValue": [
"premium",
"newsletter"
],
"newValue": [
"premium",
"newsletter",
"vip"
],
"extra": [
{
"action": "ADDED",
"id": "686dd294334be8606a5bf312",
"value": "vip"
}
]
}
}
}
}
```
Ejemplo de payload cuando se crea un nuevo contacto
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_2345678901",
"type": "contact.created",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"contactCreated": {
"id": "1824266594102064128",
"remarkName": "Priority customer",
"nickName": "John Doe",
"realName": "John Smith",
"phoneNumber": "+16315551111",
"countryCode": "US",
"countryName": "United States",
"email": "john.doe@example.com",
"sourceType": "api",
"sourceId": "import_batch_123",
"sourceUrl": "https://example.com/signup",
"lastSeen": "2024-01-01T11:59:00.000Z",
"lastConnectedNumber": "+16315552222",
"ownerEmail": "owner@example.com",
"tags": [
"premium",
"newsletter"
],
"createTime": "2024-01-01T12:00:00.000Z",
"updateTime": "2024-01-01T12:00:00.000Z",
"blocked": false,
"customAttributes": {
"attr1": "value1",
"attr2": "value2",
"attr3": 123
}
}
}
```
Ejemplo de payload cuando se elimina un contacto
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_3456789012",
"type": "contact.deleted",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"contactDeleted": {
"id": "1824266594102064128",
"remarkName": "Former customer",
"nickName": "John Doe",
"phoneNumber": "+16315551111",
"updateTime": "2024-01-01T12:00:00.000Z"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890abcdef12345678",
"type": "contact.note.created",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"contactNote": {
"id": "6a3de646e18f344f743aaa4d",
"contactId": "1824266594102064128",
"username": "alice_01",
"phoneNumber": "+16315551111",
"content": "Customer prefers follow-up in the morning.",
"createTime": "2024-01-01T12:00:00.000Z",
"updateTime": "2024-01-01T12:00:00.000Z"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_2234567890abcdef12345678",
"type": "contact.note.updated",
"apiVersion": "v2",
"createTime": "2024-01-02T12:00:00.000Z",
"contactNote": {
"id": "6a3de646e18f344f743aaa4d",
"contactId": "1824266594102064128",
"username": "alice_01",
"phoneNumber": "+16315551111",
"content": "Customer now prefers afternoon follow-up.",
"createTime": "2024-01-01T12:00:00.000Z",
"updateTime": "2024-01-02T12:00:00.000Z"
}
}
```
Emitido únicamente para la eliminación independiente de una nota, no para la eliminación en cascada de un contacto.
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_3234567890abcdef12345678",
"type": "contact.note.deleted",
"apiVersion": "v2",
"createTime": "2024-01-03T12:00:00.000Z",
"contactNote": {
"id": "6a3de646e18f344f743aaa4d",
"contactId": "1824266594102064128",
"username": "alice_01",
"phoneNumber": "+16315551111",
"content": "Customer now prefers afternoon follow-up.",
"createTime": "2024-01-01T12:00:00.000Z",
"updateTime": "2024-01-02T12:00:00.000Z"
}
}
```
Ejemplo de payload cuando un cliente cancela la suscripción
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_3456789012",
"type": "contact.unsubscribe.created",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"unsubscriberChanged": {
"phoneNumber": "+16315551111",
"source": "Whatsapp",
"updateTime": "2024-01-01T12:00:00.000Z"
}
}
```
Ejemplo de payload cuando un cliente reanuda la suscripción
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_3456789012",
"type": "contact.unsubscribe.deleted",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"unsubscriberChanged": {
"phoneNumber": "+16315551111",
"source": "Whatsapp",
"updateTime": "2024-01-01T12:00:00.000Z"
}
}
```
Ejemplo de payload cuando un Business Username de número de teléfono de WhatsApp pasa a estar activo
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_business_username_updated_123",
"type": "whatsapp.phone_number.business_username_updated",
"apiVersion": "v2",
"createTime": "2026-05-26T12:00:00.000Z",
"whatsappPhoneNumber": {
"id": "1234567890123456",
"phoneNumber": "+16315551111",
"displayPhoneNumber": "+1 631-555-1111",
"wabaId": "whatsapp-business-account-id",
"businessUsername": "acme.support",
"businessUsernameStatus": "active",
"businessUsernameUpdatedAt": "2026-05-26T12:00:00.000Z"
}
}
```
Ejemplo de payload cuando un número de teléfono de WhatsApp tiene una solicitud de Business Username reservada
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_business_username_pending_123",
"type": "whatsapp.phone_number.business_username_updated",
"apiVersion": "v2",
"createTime": "2026-05-26T12:30:00.000Z",
"whatsappPhoneNumber": {
"id": "1234567890123456",
"phoneNumber": "+16315551111",
"displayPhoneNumber": "+1 631-555-1111",
"wabaId": "whatsapp-business-account-id",
"businessUsername": "acme.support",
"businessUsernameStatus": "reserved",
"requestedBusinessUsername": "acme.help",
"businessUsernameUpdatedAt": "2026-05-26T12:30:00.000Z"
}
}
```
Meta detectó contenido de marketing en un mensaje de Utility Direct Send. Suscríbete a este evento a través de la API de endpoint de webhook.
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_direct_send_category_123",
"type": "whatsapp.template.correct_category_detection",
"apiVersion": "v2",
"createTime": "2026-09-17T08:00:00.000Z",
"whatsappTemplate": {
"officialTemplateId": "official-template-id",
"wabaId": "whatsapp-business-account-id",
"name": "auto_generated_sample",
"language": "en_US",
"category": "MARKETING",
"previousCategory": "UTILITY"
}
}
```
Meta restringió Utility Direct Send durante 7 días tras un uso indebido reiterado de categorías.
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_direct_send_restriction_123",
"type": "whatsapp.business_account.updated",
"apiVersion": "v2",
"createTime": "2026-09-17T08:00:00.000Z",
"whatsappBusinessAccount": {
"id": "whatsapp-business-account-id",
"name": "Example business",
"updateEvent": "ACCOUNT_RESTRICTION",
"violationType": "DIRECT_SEND_UTILITY_CATEGORY_ABUSE_STRIKE_1",
"restrictions": [
{
"restrictionType": "RESTRICTED_DIRECT_SEND_UTILITY_TEMPLATES",
"expiration": "2026-09-24T08:00:00.000Z"
}
]
}
}
```
Ejemplo de payload cuando se archiva una plantilla de WhatsApp
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_template_archived_123",
"type": "whatsapp.template.reviewed",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappTemplate": {
"id": "template-id",
"officialTemplateId": "official-template-id",
"wabaId": "whatsapp-business-account-id",
"name": "sample_whatsapp_template",
"language": "en",
"category": "MARKETING",
"status": "ARCHIVED",
"statusUpdateEvent": "ARCHIVED",
"createTime": "2024-01-01T12:00:00.000Z",
"updateTime": "2024-01-01T12:00:00.000Z"
}
}
```
Ejemplo de payload cuando se desarchiva una plantilla de WhatsApp. El estado de la plantilla es el estado actual devuelto por Meta y no representa una nueva revisión de aprobación.
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_template_unarchived_123",
"type": "whatsapp.template.reviewed",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappTemplate": {
"id": "template-id",
"officialTemplateId": "official-template-id",
"wabaId": "whatsapp-business-account-id",
"name": "sample_whatsapp_template",
"language": "en",
"category": "MARKETING",
"status": "APPROVED",
"statusUpdateEvent": "UNARCHIVED",
"createTime": "2024-01-01T12:00:00.000Z",
"updateTime": "2024-01-01T12:00:00.000Z"
}
}
```
Ejemplo de payload cuando se conecta una llamada de WhatsApp
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_call_connect_123",
"type": "whatsapp.call.connect",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"callingConnect": {
"id": "6757b723960b25543b9ecc66",
"wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABIYIEF",
"phoneId": "461269257068832",
"from": "+6281361905133",
"to": "+6283138205150",
"direction": "USER_INITIATED",
"dialTime": 1733826430000,
"sdpType": "offer",
"sdp": "v=0\r\no=- 1732169627243 2 IN IP4 127.0.0.1\r\ns=-\r\nt=0 0\r\na=group:BUNDLE audio\r\na=msid-semantic: WMS af3b01e3-eb42-4244-812e-db903c062ae7\r\na=ice-lite\r\nm=audio 3480 UDP/TLS/RTP/SAVPF 111 126\r\nc=IN IP4 31.13.87.130\r\na=rtcp:9 IN IP4 0.0.0.0\r\na=candidate:785588535 1 udp 2122260223 31.13.87.130 3480 typ host generation 0 network-cost 50\r\na=candidate:1906600321 1 udp 2122262783 2a03:2880:f217:d0:face:b00c:0:699c 3480 typ host generation 0 network-cost 50\r\na=ice-ufrag:CvRXRnInnWhQzLIE\r\na=ice-pwd:HGXUGAFI8wK6seuVknBT2Q==\r\na=fingerprint:sha-256 FB:56:A1:C5:37:35:6C:5C:1B:05:23:B0:DD:BB:2E:C9:5F:E4:70:61:7B:D9:1D:09:84:76:46:23:12:38:B7:01\r\na=setup:actpass\r\na=mid:audio\r\na=sendrecv\r\na=msid:af3b01e3-eb42-4244-812e-db903c062ae7 WhatsAppTrack1\r\na=rtcp-mux\r\na=rtpmap:111 opus/48000/2\r\na=rtcp-fb:111 transport-cc\r\na=fmtp:111 maxaveragebitrate=20000;maxplaybackrate=16000;minptime=20;sprop-maxcapturerate=16000;useinbandfec=1\r\na=rtpmap:126 telephone-event/8000\r\na=maxptime:20\r\na=ptime:20\r\na=ssrc:659928310 cname:WhatsAppAudioStream1\r\n"
}
}
```
Ejemplo de payload cuando se finaliza una llamada de WhatsApp
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_6757b889a5a42d369ef48481",
"type": "whatsapp.call.terminate",
"apiVersion": "v2",
"createTime": "2024-12-10T03:42:01.822Z",
"callingTerminate": {
"id": "6757b889960b25543b9ecc67",
"wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABIYIEFENjB",
"phoneId": "461269257068832",
"from": "+6281361905133",
"to": "+6283138205150",
"direction": "USER_INITIATED",
"startTime": 1733734738000,
"endTime": 1733734771000,
"duration": 33,
"status": "COMPLETED"
}
}
```
Ejemplo de payload cuando se actualiza el estado de una llamada de WhatsApp
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_676e5ab57a9cb742d02d7646",
"type": "whatsapp.call.status.updated",
"apiVersion": "v2",
"createTime": "2024-12-27T07:41:28.422Z",
"callingStatusUpdated": {
"wabaId": "188234691048809",
"wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABE",
"phoneId": "461269257068832",
"status": "RINGING",
"recipientPhone": "+6281361905133"
}
}
```
Ejemplo de payload cuando una grabación de llamada originada por la API pasa a estar disponible
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_call_recording_01JZ8K4V7H3P6Q9R2T5W8X1Y4Z",
"type": "whatsapp.call.recording.updated",
"apiVersion": "v2",
"createTime": "2026-08-04T08:00:00.000Z",
"callingRecording": {
"wacid": "wacid.HBgNNjI4MTM2MTkwNTEzMxUCABE",
"phoneId": "461269257068832",
"mediaAssetId": "66b1f0c2e4b05c2d8f1a3b47",
"status": "AVAILABLE"
}
}
```
Ejemplo de payload cuando una transcripción de llamada originada por la API falla permanentemente
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"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
}
}
}
```
Ejemplo de payload cuando se crea un grupo de WhatsApp
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_group_lifecycle_123",
"type": "whatsapp.group.lifecycle_update",
"apiVersion": "v2",
"createTime": "2026-05-13T00:00:00.000Z",
"whatsappGroup": {
"wabaId": "123456789012345",
"displayPhoneNumber": "16315551111",
"phoneNumberId": "1234567890123456",
"field": "group_lifecycle_update",
"type": "group_create",
"requestId": "REQ_1",
"status": "created",
"groupId": "120363345678901234@g.us",
"inviteLink": "https://chat.whatsapp.com/AbCdEfGhIjK",
"subject": "New Purchase Inquiry",
"description": "Group for purchase inquiries.",
"joinApprovalMode": "auto_approve",
"webhookTime": "2026-05-13T00:00:00.000Z",
"dedupeKey": "123456789012345|REQ_1|group_lifecycle_update|group_create|created"
}
}
```
Ejemplo de payload cuando se agregan participantes a un grupo de WhatsApp
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_group_participants_123",
"type": "whatsapp.group.participants_update",
"apiVersion": "v2",
"createTime": "2026-05-13T00:00:00.000Z",
"whatsappGroup": {
"wabaId": "123456789012345",
"field": "group_participants_update",
"type": "group_participants_add",
"status": "added",
"groupId": "120363345678901234@g.us",
"waId": "16315551111",
"recipientUserId": "US.1234",
"parentRecipientUserId": "US.parent123",
"customerProfile": {
"name": "John Doe",
"username": "john_doe"
},
"addedParticipants": [
{
"input": "US.1234",
"waId": "16315551111",
"recipientUserId": "US.1234",
"parentRecipientUserId": "US.parent123",
"customerProfile": {
"name": "John Doe",
"username": "john_doe"
}
}
],
"webhookTime": "2026-05-13T00:00:00.000Z"
}
}
```
Ejemplo de payload cuando se actualiza la configuración de un grupo de WhatsApp
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"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": "120363345678901234@g.us",
"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"
}
}
```
Ejemplo de payload cuando cambia el estado de suspensión de un grupo de WhatsApp
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_group_status_123",
"type": "whatsapp.group.status_update",
"apiVersion": "v2",
"createTime": "2026-05-13T00:00:00.000Z",
"whatsappGroup": {
"wabaId": "123456789012345",
"field": "group_status_update",
"type": "group_suspend",
"status": "suspended",
"groupId": "120363345678901234@g.us",
"webhookTime": "2026-05-13T00:00:00.000Z"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "email.delivery.updated",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"emailDelivery": {
"emailId": "",
"recipientAddress": "tom@example.com",
"status": "failed",
"errorCode": 402,
"errorMessage": "Unsubscribes",
"externalId": "",
"bizType": "email",
"verificationId": "VERIFICATION-ID"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "sms.message.updated",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"sms": {
"id": "",
"to": "+16315551111",
"text": "Your verification code is 123456.",
"senderId": "Brand",
"regionCode": "US",
"totalSegments": 1,
"totalPrice": 0.0085,
"currency": "USD",
"status": "sent",
"errorCode": "",
"createTime": "2022-03-01T12:00:00.000Z",
"updateTime": "2022-03-01T12:00:00.000Z",
"externalId": "",
"callbackUrl": "https://httpbin.org/anything?tag=api-sms",
"bizType": "sms",
"verificationId": "VERIFICATION-ID"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "sms.inbound.received",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"smsInbound": {
"id": "",
"from": "+16315551111",
"to": "",
"text": "",
"sendTime": "2022-06-01T12:00:00.000Z"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "voice.message.updated",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"voice": {
"id": "",
"to": "+16315551111",
"verificationCode": "123456",
"language": "en",
"regionCode": "US",
"totalSegments": 1,
"totalPrice": 0.05,
"currency": "USD",
"status": "sent",
"errorCode": "",
"createTime": "2022-03-01T12:00:00.000Z",
"updateTime": "2022-03-01T12:00:00.000Z",
"externalId": "",
"callbackUrl": "https://httpbin.org/anything?tag=api-voice",
"bizType": "voice",
"verificationId": "VERIFICATION-ID"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.business_account.deleted",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappBusinessAccount": {
"id": "",
"name": "",
"currency": "",
"messageTemplateNamespace": "",
"accountReviewStatus": "PENDING",
"businessVerificationStatus": "expired",
"country": "",
"ownershipType": "",
"paymentMethodAttached": false,
"primaryFundingId": "",
"purchaseOrderNumber": "",
"timezoneId": "1",
"decision": "APPROVED",
"updateEvent": "DISABLED_UPDATE",
"banState": "SCHEDULE_FOR_DISABLE",
"banDate": "December 9, 2022",
"violationType": "SCAM",
"restrictions": [
{
"restrictionType": "RESTRICTED_ADD_PHONE_NUMBER_ACTION",
"expiration": "2022-06-01T12:00:00.000Z"
}
],
"maxPhoneNumbersPerBusiness": 20,
"maxPhoneNumbersPerWaba": 25,
"authIntlRateEligibilityCountries": [
{
"countryCode": "IN",
"startTime": "2024-07-01T00:00:00.000Z"
}
],
"primaryBusinessLocation": "US",
"removedReason": "ACCOUNT_DISCONNECTED",
"removedInitiatedBy": "USER",
"removedTime": "2026-05-19T12:00:00.000Z"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.business_account.reviewed",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappBusinessAccount": {
"id": "",
"name": "",
"currency": "",
"messageTemplateNamespace": "",
"accountReviewStatus": "PENDING",
"businessVerificationStatus": "expired",
"country": "",
"ownershipType": "",
"paymentMethodAttached": false,
"primaryFundingId": "",
"purchaseOrderNumber": "",
"timezoneId": "1",
"decision": "APPROVED",
"updateEvent": "DISABLED_UPDATE",
"banState": "SCHEDULE_FOR_DISABLE",
"banDate": "December 9, 2022",
"violationType": "SCAM",
"restrictions": [
{
"restrictionType": "RESTRICTED_ADD_PHONE_NUMBER_ACTION",
"expiration": "2022-06-01T12:00:00.000Z"
}
],
"maxPhoneNumbersPerBusiness": 20,
"maxPhoneNumbersPerWaba": 25,
"authIntlRateEligibilityCountries": [
{
"countryCode": "IN",
"startTime": "2024-07-01T00:00:00.000Z"
}
],
"primaryBusinessLocation": "US",
"removedReason": "ACCOUNT_DISCONNECTED",
"removedInitiatedBy": "USER",
"removedTime": "2026-05-19T12:00:00.000Z"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.inbound_message.received",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappInboundMessage": {
"id": "",
"wamid": "wamid.BgNODYxN...",
"wabaId": "whatsapp-business-account-id",
"from": "+16315551111",
"fromUserId": "US.1234",
"fromParentUserId": "US.ENT.1234",
"customerProfile": {
"name": "John",
"username": "john_doe"
},
"to": "+16315551111",
"sendTime": "2022-06-01T12:00:00.000Z",
"type": "text",
"text": {
"body": ""
},
"image": {
"id": "",
"link": "",
"caption": "",
"filename": "",
"metadata": {
"key": {}
},
"mime_type": "",
"sha256": ""
},
"video": {
"id": "",
"link": "",
"caption": "",
"filename": "",
"metadata": {
"key": {}
},
"mime_type": "",
"sha256": ""
},
"audio": {
"id": "",
"link": "",
"caption": "",
"filename": "",
"metadata": {
"key": {}
},
"mime_type": "",
"sha256": ""
},
"document": {
"id": "",
"link": "",
"caption": "",
"filename": "",
"metadata": {
"key": {}
},
"mime_type": "",
"sha256": ""
},
"sticker": {
"id": "",
"link": "",
"caption": "",
"filename": "",
"metadata": {
"key": {}
},
"mime_type": "",
"sha256": ""
},
"interactive": {
"type": "button_reply",
"button_reply": {
"id": "",
"title": ""
},
"list_reply": {
"id": "",
"title": "",
"description": ""
},
"nfm_reply": {
"name": "flow",
"response_json": "{\"flow_token\":\"unused\",\"screen_0_firstName_0\":\"王\",\"screen_1_TextInput_1\":\"123\",\"screen_1_TextInput_0\":\"11\",\"screen_0_lastName_1\":\"TESTNAME\"}",
"body": "Sent"
},
"call_permission_reply": {
"response": "accept",
"expiration_timestamp": 1672531200,
"is_permanent": false
}
},
"location": {
"latitude": 0.0,
"longitude": 0.0,
"address": "",
"name": "",
"url": ""
},
"button": {
"payload": "",
"text": ""
},
"contacts": [
{
"addresses": [
{
"street": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"country_code": "",
"type": "WORK"
}
],
"birthday": "2022-09-27",
"emails": [
{
"email": "",
"type": "WORK"
}
],
"name": {
"formatted_name": "",
"first_name": "",
"last_name": "",
"middle_name": "",
"suffix": "",
"prefix": ""
},
"org": {
"company": "",
"department": "",
"title": ""
},
"phones": [
{
"phone": "",
"type": "",
"wa_id": ""
}
],
"urls": [
{
"url": "",
"type": ""
}
],
"vcard": "",
"origin": "contact_request"
}
],
"reaction": {
"message_id": "wamid.BgNODYxN...",
"emoji": ""
},
"order": {
"catalog_id": "the-catalog_id",
"product_items": [
{
"product_retailer_id": "",
"quantity": 0,
"item_price": 0.0,
"currency": "USD"
}
],
"text": ""
},
"system": {
"body": "",
"wa_id": "",
"user_id": "US.13491208655302741919",
"parent_user_id": "US.ENT.11815799212886844831",
"type": "",
"user": "",
"new_wa_id": ""
},
"errors": [
{
"code": 131051,
"title": "Message type unknown",
"message": "Message type unknown",
"error_data": {}
}
],
"context": {
"forwarded": false,
"frequently_forwarded": false,
"from": "",
"id": "wamid.BgNODYxN...",
"referred_product": {
"catalog_id": "",
"product_retailer_id": ""
}
},
"referral": {
"source_url": "",
"source_type": "",
"source_id": "",
"headline": "",
"body": "",
"media_type": "",
"image_url": "",
"video_url": "",
"thumbnail_url": "",
"ctwa_clid": ""
},
"groupId": "120363345678901234@g.us"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.message.updated",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappMessage": {
"id": "",
"wamid": "wamid.BgNODYxN...",
"wabaId": "whatsapp-business-account-id",
"from": "+16315551111",
"to": "+16315551111",
"recipient": "US.1234",
"recipientUserId": "US.1234",
"toUserId": "US.1234",
"parentRecipientUserId": "US.parent123",
"toParentUserId": "US.parent123",
"customerProfile": {
"name": "John",
"username": "john_doe"
},
"conversation": {
"id": "",
"type": "FREE_ENTRY",
"originType": "referral_conversion",
"expireTime": "2022-06-01T12:00:00.000Z"
},
"type": "template",
"template": {
"name": "sample_whatsapp_template",
"language": {
"code": "en_US",
"policy": "deterministic"
},
"components": [
{
"type": "header",
"sub_type": "quick_reply",
"index": 0,
"parameters": [
{
"type": "text",
"text": "",
"payload": "",
"coupon_code": "",
"image": {
"id": "",
"link": "",
"caption": "",
"filename": ""
},
"gif": {
"id": "",
"link": "",
"caption": "",
"filename": ""
},
"video": {
"id": "",
"link": "",
"caption": "",
"filename": ""
},
"document": {
"id": "",
"link": "",
"caption": "",
"filename": ""
},
"limited_time_offer": {
"expiration_time_ms": "1698562800000"
},
"action": {
"thumbnail_product_retailer_id": "2lc20305pt",
"sections": [
{}
],
"flow_token": "",
"flow_action_data": {
"key": {}
},
"order_details": {
"currency": "",
"reference_id": "",
"type": "",
"payment_settings": []
}
},
"order_status": {
"reference_id": "",
"order": {
"type": "",
"catalog_id": "",
"items": [],
"description": ""
}
},
"location": {
"latitude": 0.0,
"longitude": 0.0,
"name": "",
"address": ""
}
}
],
"cards": [
{
"card_index": 0,
"components": [
{
"type": "header",
"sub_type": "quick_reply",
"index": 0,
"parameters": []
}
]
}
]
}
]
},
"text": {
"body": "",
"preview_url": false
},
"image": {
"id": "",
"link": "",
"caption": "",
"filename": ""
},
"video": {
"id": "",
"link": "",
"caption": "",
"filename": ""
},
"audio": {
"id": "",
"link": "",
"caption": "",
"filename": ""
},
"document": {
"id": "",
"link": "",
"caption": "",
"filename": ""
},
"sticker": {
"id": "",
"link": "",
"caption": "",
"filename": ""
},
"location": {
"latitude": 0.0,
"longitude": 0.0,
"name": "",
"address": ""
},
"interactive": {
"type": "button",
"action": {
"buttons": [
{
"type": "reply",
"reply": {
"title": "",
"id": ""
}
}
],
"button": "",
"catalog_id": "",
"product_retailer_id": "",
"sections": [
{
"title": "",
"rows": [
{
"id": "",
"title": "",
"description": ""
}
],
"product_items": [
{
"product_retailer_id": ""
}
]
}
],
"name": "cta_url",
"parameters": {
"display_text": "See Docs",
"url": "https://developers.facebook.com/docs/whatsapp",
"thumbnail_product_retailer_id": "",
"flow_message_version": "",
"flow_token": "",
"flow_id": "",
"flow_name": "",
"flow_cta": "Open flow!",
"flow_action": "navigate",
"flow_action_payload": {
"screen": "",
"data": {
"key": {}
}
},
"reference_id": "",
"type": "",
"beneficiaries": [
{
"name": "",
"address_line1": "",
"address_line2": "",
"city": "",
"state": "",
"country": "",
"postal_code": ""
}
],
"currency": "",
"total_amount": {
"offset": 100,
"value": 1234,
"description": "",
"discount_program_name": ""
},
"order": {
"status": "pending",
"type": "",
"catalog_id": "",
"items": [
{
"retailer_id": "",
"name": "",
"image": {},
"amount": {},
"sale_amount": {},
"quantity": 0,
"country_of_origin": "",
"importer_name": "",
"importer_address": ""
}
],
"subtotal": {
"offset": 100,
"value": 1234,
"description": "",
"discount_program_name": ""
},
"tax": {
"offset": 100,
"value": 1234,
"description": "",
"discount_program_name": ""
},
"shipping": {
"offset": 100,
"value": 1234,
"description": "",
"discount_program_name": ""
},
"discount": {
"offset": 100,
"value": 1234,
"description": "",
"discount_program_name": ""
},
"expiration": {
"timestamp": "1727438564",
"description": ""
},
"description": ""
},
"payment_settings": [
{
"type": "payment_gateway",
"payment_gateway": {
"type": "billdesk",
"configuration_name": "",
"billdesk": {},
"payu": {},
"razorpay": {},
"zaakpay": {}
}
}
]
}
},
"body": {
"text": ""
},
"header": {
"type": "text",
"text": "",
"image": {
"id": "",
"link": "",
"caption": "",
"filename": ""
},
"video": {
"id": "",
"link": "",
"caption": "",
"filename": ""
},
"document": {
"id": "",
"link": "",
"caption": "",
"filename": ""
}
},
"footer": {
"text": ""
}
},
"contacts": [
{
"addresses": [
{
"street": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"country_code": "",
"type": "WORK"
}
],
"birthday": "2022-09-27",
"emails": [
{
"email": "",
"type": "WORK"
}
],
"name": {
"formatted_name": "",
"first_name": "",
"last_name": "",
"middle_name": "",
"suffix": "",
"prefix": ""
},
"org": {
"company": "",
"department": "",
"title": ""
},
"phones": [
{
"phone": "",
"type": "",
"wa_id": ""
}
],
"urls": [
{
"url": "",
"type": ""
}
],
"vcard": "",
"origin": "contact_request"
}
],
"reaction": {
"message_id": "wamid.BgNODYxN...",
"emoji": ""
},
"context": {
"message_id": "wamid.BgNODYxN..."
},
"externalId": "",
"category": "utility",
"ttlSeconds": 600,
"status": "accepted",
"errorCode": "INTERNAL_SERVER_ERROR",
"errorMessage": "",
"createTime": "2022-06-01T12:00:00.000Z",
"updateTime": "2022-06-01T12:00:00.000Z",
"sendTime": "2022-06-01T12:00:00.000Z",
"deliverTime": "2022-06-01T12:00:00.000Z",
"readTime": "2022-06-01T12:00:00.000Z",
"totalPrice": 0.05,
"currency": "USD",
"regionCode": "US",
"pricingCategory": "referral_conversion",
"pricingModel": "PMP",
"pricingType": "regular",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": ""
},
"bizType": "whatsapp",
"verificationId": "VERIFICATION-ID"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.phone_number.deleted",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappPhoneNumber": {
"id": "1234567890123456",
"phoneNumber": "+16315551111",
"displayPhoneNumber": "+1 631-555-1111",
"wabaId": "whatsapp-business-account-id",
"businessUsername": "acme.support",
"businessUsernameStatus": "not_set",
"requestedBusinessUsername": "acme.help",
"businessUsernameUpdatedAt": "2026-05-26T12:00:00.000Z",
"qualityRating": "GREEN",
"messagingLimit": "TIER_1K",
"whatsappBusinessManagerMessagingLimit": "",
"verifiedName": "John’s Cake Shop",
"codeVerificationStatus": "VERIFIED",
"isOfficialBusinessAccount": false,
"status": "PENDING",
"nameStatus": "APPROVED",
"newNameStatus": "APPROVED",
"decision": "APPROVED",
"requestedVerifiedName": "",
"rejectionReason": "",
"qualityUpdateEvent": "ONBOARDING",
"updateEvent": "ACCOUNT_OFFBOARDED",
"throughputLevel": "HIGH"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.phone_number.name_updated",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappPhoneNumber": {
"id": "1234567890123456",
"phoneNumber": "+16315551111",
"displayPhoneNumber": "+1 631-555-1111",
"wabaId": "whatsapp-business-account-id",
"businessUsername": "acme.support",
"businessUsernameStatus": "not_set",
"requestedBusinessUsername": "acme.help",
"businessUsernameUpdatedAt": "2026-05-26T12:00:00.000Z",
"qualityRating": "GREEN",
"messagingLimit": "TIER_1K",
"whatsappBusinessManagerMessagingLimit": "",
"verifiedName": "John’s Cake Shop",
"codeVerificationStatus": "VERIFIED",
"isOfficialBusinessAccount": false,
"status": "PENDING",
"nameStatus": "APPROVED",
"newNameStatus": "APPROVED",
"decision": "APPROVED",
"requestedVerifiedName": "",
"rejectionReason": "",
"qualityUpdateEvent": "ONBOARDING",
"updateEvent": "ACCOUNT_OFFBOARDED",
"throughputLevel": "HIGH"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.phone_number.quality_updated",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappPhoneNumber": {
"id": "1234567890123456",
"phoneNumber": "+16315551111",
"displayPhoneNumber": "+1 631-555-1111",
"wabaId": "whatsapp-business-account-id",
"businessUsername": "acme.support",
"businessUsernameStatus": "not_set",
"requestedBusinessUsername": "acme.help",
"businessUsernameUpdatedAt": "2026-05-26T12:00:00.000Z",
"qualityRating": "GREEN",
"messagingLimit": "TIER_1K",
"whatsappBusinessManagerMessagingLimit": "",
"verifiedName": "John’s Cake Shop",
"codeVerificationStatus": "VERIFIED",
"isOfficialBusinessAccount": false,
"status": "PENDING",
"nameStatus": "APPROVED",
"newNameStatus": "APPROVED",
"decision": "APPROVED",
"requestedVerifiedName": "",
"rejectionReason": "",
"qualityUpdateEvent": "ONBOARDING",
"updateEvent": "ACCOUNT_OFFBOARDED",
"throughputLevel": "HIGH"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.template.category_updated",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappTemplate": {
"officialTemplateId": "official-template-id",
"wabaId": "whatsapp-business-account-id",
"name": "",
"language": "en_US",
"category": "AUTHENTICATION",
"subCategory": "ORDER_STATUS",
"previousCategory": "",
"messageSendTtlSeconds": 600,
"components": [
{
"type": "BODY",
"format": "TEXT",
"text": "",
"buttons": [
{
"type": "PHONE_NUMBER",
"text": "",
"url": "",
"phone_number": 15550051310,
"otp_type": "COPY_CODE",
"autofill_text": "Autofill",
"package_name": "com.example.myapplication",
"signature_hash": "K8a%2FAINcGX7",
"zero_tap_terms_accepted": false,
"example": [
""
],
"flow_id": "1",
"flow_name": "",
"flow_json": "",
"flow_action": "navigate",
"navigate_screen": "WELCOME_SCREEN"
}
],
"add_security_recommendation": false,
"code_expiration_minutes": 5,
"limited_time_offer": {
"text": "Expiring offer!",
"has_expiration": false
},
"example": {
"body_text": [
[
""
]
],
"header_text": [
""
],
"header_url": [
""
]
},
"cards": [
{
"components": [
{
"type": "BODY",
"format": "IMAGE",
"text": "",
"buttons": [
{
"text": "",
"url": "",
"phone_number": 15550051310,
"autofill_text": "Autofill",
"package_name": "com.example.myapplication",
"signature_hash": "K8a%2FAINcGX7",
"zero_tap_terms_accepted": false,
"example": [],
"flow_id": "1",
"flow_name": "",
"flow_json": "",
"flow_action": "navigate",
"navigate_screen": "WELCOME_SCREEN"
}
],
"example": {
"body_text": [
[]
],
"header_text": [
""
],
"header_url": [
""
]
}
}
]
}
]
}
],
"status": "REJECTED",
"qualityRating": "GREEN",
"reason": "",
"createTime": "2022-06-01T12:00:00.000Z",
"updateTime": "2022-06-01T12:00:00.000Z",
"statusUpdateEvent": "PENDING",
"disableDate": "December 9, 2022",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": ""
}
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.template.quality_updated",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappTemplate": {
"officialTemplateId": "official-template-id",
"wabaId": "whatsapp-business-account-id",
"name": "",
"language": "en_US",
"category": "AUTHENTICATION",
"subCategory": "ORDER_STATUS",
"previousCategory": "",
"messageSendTtlSeconds": 600,
"components": [
{
"type": "BODY",
"format": "TEXT",
"text": "",
"buttons": [
{
"type": "PHONE_NUMBER",
"text": "",
"url": "",
"phone_number": 15550051310,
"otp_type": "COPY_CODE",
"autofill_text": "Autofill",
"package_name": "com.example.myapplication",
"signature_hash": "K8a%2FAINcGX7",
"zero_tap_terms_accepted": false,
"example": [
""
],
"flow_id": "1",
"flow_name": "",
"flow_json": "",
"flow_action": "navigate",
"navigate_screen": "WELCOME_SCREEN"
}
],
"add_security_recommendation": false,
"code_expiration_minutes": 5,
"limited_time_offer": {
"text": "Expiring offer!",
"has_expiration": false
},
"example": {
"body_text": [
[
""
]
],
"header_text": [
""
],
"header_url": [
""
]
},
"cards": [
{
"components": [
{
"type": "BODY",
"format": "IMAGE",
"text": "",
"buttons": [
{
"text": "",
"url": "",
"phone_number": 15550051310,
"autofill_text": "Autofill",
"package_name": "com.example.myapplication",
"signature_hash": "K8a%2FAINcGX7",
"zero_tap_terms_accepted": false,
"example": [],
"flow_id": "1",
"flow_name": "",
"flow_json": "",
"flow_action": "navigate",
"navigate_screen": "WELCOME_SCREEN"
}
],
"example": {
"body_text": [
[]
],
"header_text": [
""
],
"header_url": [
""
]
}
}
]
}
]
}
],
"status": "REJECTED",
"qualityRating": "GREEN",
"reason": "",
"createTime": "2022-06-01T12:00:00.000Z",
"updateTime": "2022-06-01T12:00:00.000Z",
"statusUpdateEvent": "PENDING",
"disableDate": "December 9, 2022",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": ""
}
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.flow.status_change",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"flowChanges": {
"flowId": "1097420589034000",
"wabaId": "",
"message": "Flow Webhook 3 changed status from DRAFT to PUBLISHED",
"oldStatus": "DRAFT",
"newStatus": "PUBLISHED"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.payment.updated",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappPayment": {
"wabaId": "",
"referenceId": "",
"status": "captured",
"transactions": [
{
"id": "",
"type": "billdesk",
"status": "pending",
"createdTimestamp": 0,
"updatedTimestamp": 0,
"amount": {
"offset": 100,
"value": 1234,
"description": "",
"discount_program_name": ""
},
"currency": "",
"methodType": "upi",
"error": {
"code": "",
"reason": ""
}
}
]
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.user.preferences",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z",
"whatsappUserPreference": {
"wabaId": 1234123123,
"businessPhoneNumber": "+16315551111",
"businessPhoneId": "1234567890123456",
"contactName": "John",
"contactPhoneNumber": "+16315551111",
"userId": "US.13491208655302741918",
"parentUserId": "US.ENT.11815799212886844830",
"detail": "User requested to stop marketing messages",
"category": "marketing_messages",
"value": "stop",
"timestamp": "1739321024000"
}
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.smb.history",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z"
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.smb.message.created",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z"
}
```
```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"id": "evt_1234567890",
"type": "whatsapp.smb.message.echoes",
"apiVersion": "v2",
"createTime": "2024-01-01T12:00:00.000Z"
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.