Webhooks for WhatsApp Business Accounts

Para recibir notificaciones en tiempo real cuando se realizan cambios en la cuenta de WhatsApp Business (WABA), puedes suscribirte al nivel de cuenta de WhatsApp Business. Para configurar Webhooks para las cuentas de WhatsApp Business:

  1. Configura tu extremo y Webhooks. Se trata de los mismos pasos que sigues para configurar Webhooks para las páginas de Facebook.
  2. Suscribe tu aplicación en la cuenta de WhatsApp Business. Debes suscribir una aplicación propiedad de tu empresa: las aplicaciones compartidas con la empresa no pueden recibir notificaciones de Webhooks.
  3. Asegúrate de que tu aplicación ha completado la revisión y ha solicitado el permiso whatsapp_business_management.

GET, POST, and DELETE calls to /{whats-app-business-account-id}/subscribed_apps are now subject to Business Use Case Rate Limits.

Set up Your Endpoint and Webhooks

Follow our Webhooks Getting Started guide to create your endpoint and configure your webhook endpoint. When you configure your endpoint, make sure to choose WhatsApp Business Account and subscribe to individual WhatsApp Business Account (WABA) fields.

Available Subscription Fields

Campos de suscripción disponibles

Nombre del campo Descripción

account_review_update

Recibirás una notificación cuando se haya revisado una cuenta de WhatsApp Business.

account_update

Recibirás una notificación cuando se produzca un cambio en tu cuenta de WhatsApp Business. Este cambio puede hacer referencia a la actualización del número de teléfono, una infracción de la política o el bloqueo de una cuenta de WhatsApp Business, entre otros.

business_capability_update

Recibirás una notificación cuando se actualice una función. Puede ser un cambio en el máximo de números de teléfono que una cuenta WABA puede tener o de conversaciones por número de teléfono.

message_template_status_update

Recibirás una notificación cuando la plantilla de mensaje se haya aprobado o rechazado, o se haya desactivado.

messages

Recibirás una notificación cuando tu empresa reciba un mensaje de un cliente, cuando envíes un mensaje a un cliente, cuando se entregue un mensaje a un cliente y cuando un cliente lea tu mensaje.

phone_number_name_update

Recibirás una notificación cuando el nombre asociado a un número de teléfono se haya aprobado o rechazado.

phone_number_quality_update

Recibirás una notificación cuando el estado relacionado con la calidad de un número de teléfono se actualice.

security

Recibirás una notificación cuando:

  • solicites desactivar el código de verificación en dos pasos;
  • se desactive el código de verificación en dos pasos;
  • se actualice el código de verificación en dos pasos.
  • Consulta la referencia sobre los webhooks de la cuenta de WhatsApp Business para obtener más información acerca de cada campo de carga útil y la referencia sobre los webhooks de la API de nube de WhatsApp para obtener más información acerca de los distintos tipos de notificaciones messages que puedes recibir.

    Subscribe Your App

    You need to subscribe your app to webhooks on a given WABA. We only send notifications if your webhooks-configured app is subscribed to webhooks on a given WABA, and only if the app has permission to edit that WABA.

    Create a Subscription

    Request

    To subscribe your app to webhooks on a WABA, send a POST request to the WABA > Subscribed Apps endpoint.

    curl -X POST 'https://graph.facebook.com/<API_VERSION>/<WHATSAPP_BUSINESS_ACCOUNT_ID>/subscribed_apps' \
    -H 'Authorization: Bearer <ACCESS_TOKEN>'

    Response

    Upon success:

    {
      "success": "true"
    }
    

    Get Subscribed Apps

    To get a list of apps subscribed to webhooks on a WABA, send a GET request to the WABA > Subscribed Apps endpoint.

    Request

    curl 'https://graph.facebook.com/<API_VERSION>/<WHATSAPP_BUSINESS_ACCOUNT_ID>/subscribed_apps' \
    -H 'Authorization: Bearer <ACCESS_TOKEN>'

    Response

    A successful response will list the subscribed apps:

    {
      "data": [
        {
          "whatsapp_business_api_data": {
            "link": "<APP_1_URL>",
            "name": "<APP_1_NAME>",
            "id": "<APP_1_ID>"
          }
        },
        {
          "whatsapp_business_api_data": {
            "link": "<APP_2_URL>",
            "name": "<APP_2_NAME>",
            "id": "<APP_2_ID>"
          }
        },
        ...
      ]
    }

    Delete a subscription

    To unsubscribe your app from webhooks on a WABA, send a DELETE request to the subscribed_apps endpoint.

    Request

    curl -X DELETE 'https://graph.facebook.com/<AP_VERSION>/<WHATSAPP_BUSINESS_ACCOUNT_ID>/subscribed_apps' \
    -H 'Authorization: Bearer <ACCESS_TOKEN>'

    Response

    A successful response will read:

    {
      "success": "true"
    }
    

    Subscribe with Graph API Explorer

    If you don't want to subscribe your app with direct API calls, you can easily do it with Graph API Explorer.

    Replace the me?fields=id,name query with <WHATSAPP_BUSINESS_ACCT_ID>/subscribed_apps. It will subscribe the app you use to send the POST request in Graph Explorer.

    Your app must have permission to edit the WhatsApp business account in order to successfully subscribe.

    Example Webhook payload:

    [
      {
        "object": "whatsapp_business_account",
        "entry": [
          {
            "id": "0",
            "time": 1602782939,
            "changes": [
              {
                "field": "phone_number_name_update",
                "value": {
                  "display_phone_number": "16505551111",
                  "decision": "APPROVED",
                  "requested_verified_name": "WhatsApp",
                  "rejection_reason": null
                }
              }
            ]
          }
        ]
      }
    ]