Примеры вебхуков для шаблонов WhatsApp

Полный каталог на основе схемы см. в разделе все примеры.

Что это такое

Используйте точное событие type, чтобы различать обновления проверки, категорий, автоопределения категорий и качества шаблонов.

Перед началом работы

Создайте публичный эндпоинт HTTPS в вашем приложении.
Настройте эндпоинт вебхука YCloud для нужных типов событий.
Надежно сохраните секретный ключ подписи эндпоинта.
Обеспечьте идемпотентность обработки событий.

Как это работает

YCloud отправляет HTTP-запрос POST при возникновении события. Проверьте подпись, надежно сохраните событие, верните ответ 2xx и выполняйте длительные операции асинхронно.

Запрос

Ниже приведены примеры запросов, доставляемых на ваш Webhook URL. Используйте id события как идентификатор доставки, а type — для маршрутизации полезной нагрузки.

Ответ

После принятия события верните статус 2xx.

HTTP/1.1 200 OK

Инструкции по настройке эндпоинта, проверке подписи и механизму повторных попыток см. в разделе Настройка вебхуков.

Шаблон одобрен

В этом случае ваш эндпоинт вебхука получил событие шаблона APPROVED:

Параметр statusUpdateEvent шаблона равен APPROVED.
Параметр status шаблона теперь имеет значение APPROVED.

Запрос

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEMtA0PkkyACiS5o",
  "type": "whatsapp.template.reviewed",
  "apiVersion": "v2",
  "createTime": "2023-02-20T12:00:00.000Z",
  "whatsappTemplate": {
    "wabaId": "WABA-ID",
    "name": "template_name",
    "language": "en",
    "category": "MARKETING",
    "status": "APPROVED",
    "reason": "NONE",
    "statusUpdateEvent": "APPROVED"
  }
}'

Ответ

Подтвердите получение после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Используйте wabaId, name и language для идентификации шаблона в вашей системе.
Поле statusUpdateEvent описывает произошедшее изменение статуса этого шаблона, тогда как status указывает текущий статус шаблона. Они не всегда совпадают.
Это событие происходит, когда шаблон одобряется Meta. Это может быть шаблон, созданный или отредактированный вами ранее. Это также происходит, когда приостановленный шаблон автоматически переходит в статус одобренного.
После одобрения шаблона вы можете использовать его для отправки шаблонных сообщений.

Шаблон отклонен

В этом случае ваш эндпоинт вебхука получил событие шаблона REJECTED:

Параметр statusUpdateEvent шаблона равен REJECTED.
Параметр status шаблона теперь имеет значение REJECTED.

Запрос

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEMtA0PkkyACiS5o",
  "type": "whatsapp.template.reviewed",
  "apiVersion": "v2",
  "createTime": "2023-02-20T12:00:00.000Z",
  "whatsappTemplate": {
    "wabaId": "WABA-ID",
    "name": "template_name",
    "language": "en",
    "category": "MARKETING",
    "status": "REJECTED",
    "reason": "SCAM",
    "statusUpdateEvent": "REJECTED"
  }
}'

Ответ

Подтвердите получение после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Это событие происходит, когда шаблон отклонен. Это может быть шаблон, созданный или отредактированный вами ранее.
После отклонения шаблона вы не можете использовать его для отправки шаблонных сообщений. Вы можете отредактировать этот шаблон, чтобы отправить его на повторную проверку.

Шаблон приостановлен

В этом случае ваш эндпоинт вебхука получил событие шаблона PAUSED:

Параметр statusUpdateEvent шаблона равен PAUSED.
Параметр status шаблона теперь имеет значение PAUSED.
Причина приостановки шаблона.

Запрос

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEMtA0PkkyACiS5o",
  "type": "whatsapp.template.reviewed",
  "apiVersion": "v2",
  "createTime": "2023-02-20T12:00:00.000Z",
  "whatsappTemplate": {
    "wabaId": "WABA-ID",
    "name": "template_name",
    "language": "en",
    "category": "MARKETING",
    "status": "PAUSED",
    "reason": "NONE",
    "statusUpdateEvent": "PAUSED"
  }
}'

Ответ

Подтвердите получение после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Это событие происходит, когда шаблон приостанавливается. Вы не можете использовать его для отправки сообщений.
Длительность приостановки следующая:
- 1-й случай: приостановка на 3 часа
- 2-й случай: приостановка на 6 часов
- 3-й случай: отключен
Событие APPROVED происходит, когда приостановленный шаблон возвращается в нормальный статус.
См. также Приостановка шаблонов.

Шаблон помечен

В этом случае ваш эндпоинт вебхука получил событие шаблона FLAGGED:

Параметр statusUpdateEvent шаблона равен FLAGGED.
Статус шаблона теперь APPROVED.
Содержит дату, когда шаблон будет отключен.

Запрос

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEMtA0PkkyACiS5o",
  "type": "whatsapp.template.reviewed",
  "apiVersion": "v2",
  "createTime": "2023-02-20T12:00:00.000Z",
  "whatsappTemplate": {
    "wabaId": "WABA-ID",
    "name": "template_name",
    "language": "en",
    "category": "MARKETING",
    "status": "APPROVED",
    "reason": "Your WhatsApp message template has been paused for 3 hours until Feb 23 at 5:28 AM UTC because it had issues.",
    "statusUpdateEvent": "FLAGGED",
    "disableDate": "February 28, 2023"
  }
}'

Ответ

Подтвердите получение после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Поле statusUpdateEvent описывает произошедшее изменение статуса этого шаблона, тогда как status указывает текущий статус шаблона. Они не всегда совпадают.

Шаблон отключен

В этом случае ваш эндпоинт вебхука получил событие шаблона DISABLED:

Параметр statusUpdateEvent шаблона равен DISABLED.
Статус шаблона теперь DISABLED.

Запрос

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEMtA0PkkyACiS5o",
  "type": "whatsapp.template.reviewed",
  "apiVersion": "v2",
  "createTime": "2023-02-20T12:00:00.000Z",
  "whatsappTemplate": {
    "wabaId": "WABA-ID",
    "name": "template_name",
    "language": "en",
    "category": "MARKETING",
    "status": "DISABLED",
    "reason": "NONE",
    "statusUpdateEvent": "DISABLED"
  }
}'

Ответ

Подтвердите получение после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Статус шаблона меняется на DISABLED при третьей приостановке.
См. также Приостановка шаблонов.

Шаблон ожидает удаления

В этом случае ваш эндпоинт вебхука получил событие шаблона PENDING_DELETION:

Параметр statusUpdateEvent шаблона равен PENDING_DELETION.
Статус шаблона теперь DELETED.

Запрос

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEMtA0PkkyACiS5o",
  "type": "whatsapp.template.reviewed",
  "apiVersion": "v2",
  "createTime": "2023-02-20T12:00:00.000Z",
  "whatsappTemplate": {
    "wabaId": "WABA-ID",
    "name": "template_name",
    "language": "en",
    "category": "MARKETING",
    "status": "DELETED",
    "reason": "NONE",
    "statusUpdateEvent": "PENDING_DELETION"
  }
}'

Ответ

Подтвердите получение после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Происходит при удалении шаблона.
Шаблон сообщения удаляется. Обратите внимание, что имя этого шаблона нельзя будет использовать повторно в течение 30 дней. Для создания новых шаблонов сообщений вам потребуется использовать другое имя.

Шаблон архивирован

В этом случае ваш эндпоинт вебхука получил событие шаблона ARCHIVED:

Параметр statusUpdateEvent шаблона равен ARCHIVED.
Параметр status шаблона теперь имеет значение ARCHIVED.

Запрос

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEMtA0PkkyACiS5o",
  "type": "whatsapp.template.reviewed",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "whatsappTemplate": {
    "wabaId": "WABA-ID",
    "name": "template_name",
    "language": "en",
    "category": "MARKETING",
    "status": "ARCHIVED",
    "reason": "NONE",
    "statusUpdateEvent": "ARCHIVED"
  }
}'

Ответ

Подтвердите получение после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Это событие происходит при архивации шаблона.
Архивированные шаблоны нельзя отправлять или редактировать.

Шаблон разархивирован

В этом случае ваш эндпоинт Webhook получил событие шаблона UNARCHIVED:

Параметр statusUpdateEvent шаблона равен UNARCHIVED.
Параметр status шаблона — это текущий статус, возвращенный Meta, например APPROVED.

Запрос

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEMtA0PkkyACiS5o",
  "type": "whatsapp.template.reviewed",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "whatsappTemplate": {
    "wabaId": "WABA-ID",
    "name": "template_name",
    "language": "en",
    "category": "MARKETING",
    "status": "APPROVED",
    "reason": "NONE",
    "statusUpdateEvent": "UNARCHIVED"
  }
}'

Ответ

Подтвердите доставку после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Это событие происходит при разархивации шаблона.
Параметр status может иметь значение APPROVED, однако это событие не означает, что шаблон был заново одобрен Meta.
Используйте statusUpdateEvent, чтобы отличить UNARCHIVED от фактического события проверки APPROVED.

Обновление категории шаблона

Используйте whatsapp.template.category_updated при изменении категории шаблона.

Запрос

{
  "id": "evt_example_whatsapp_template_category_updated",
  "type": "whatsapp.template.category_updated",
  "apiVersion": "v2",
  "createTime": "2026-05-26T12:00:00.000Z",
  "whatsappTemplate": {
    "officialTemplateId": "official-template-id",
    "wabaId": "whatsapp-business-account-id",
    "name": "order_update",
    "language": "en_US",
    "previousCategory": "UTILITY",
    "category": "MARKETING"
  }
}

Ответ

Подтвердите доставку после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Определите шаблон по officialTemplateId или по wabaId, name и language. Сравните previousCategory с текущим category. Поле previousCategory может иметь значение null для вновь созданного шаблона; обновление категории отличается от события изменения статуса проверки.

Определение категории Utility Direct Send

Используйте whatsapp.template.correct_category_detection, когда Meta обнаруживает контент, не относящийся к категории Utility, в Utility Direct Send. Подпишитесь через API эндпоинтов Webhook.

Запрос

{
  "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"
  }
}

Ответ

Подтвердите доставку после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Проверьте previousCategory и category, чтобы увидеть обнаруженное изменение. Точное имя события — whatsapp.template.correct_category_detection, а не whatsapp.template.category_updated. См. Utility Direct Send для ознакомления с процессом интеграции.

Обновление качества шаблона

Используйте whatsapp.template.quality_updated при изменении рейтинга качества шаблона.

Запрос

{
  "id": "evt_example_whatsapp_template_quality_updated",
  "type": "whatsapp.template.quality_updated",
  "apiVersion": "v2",
  "createTime": "2026-05-26T12:00:00.000Z",
  "whatsappTemplate": {
    "officialTemplateId": "official-template-id",
    "wabaId": "whatsapp-business-account-id",
    "name": "order_update",
    "language": "en_US",
    "qualityRating": "GREEN"
  }
}

Ответ

Подтвердите доставку после надежного сохранения события.

HTTP/1.1 200 OK

Пояснение

Смотрите qualityRating для определенного шаблона. Событие качества само по себе не указывает на новое одобрение или отклонение; обрабатывайте изменения статуса проверки через whatsapp.template.reviewed.

​Что это такое

​Перед началом работы

​Как это работает

​Запрос

​Ответ

​Шаблон одобрен

​Запрос

​Ответ

​Пояснение

​Шаблон отклонен

​Запрос

​Ответ

​Пояснение

​Шаблон приостановлен

​Запрос

​Ответ

​Пояснение

​Шаблон помечен

​Запрос

​Ответ

​Пояснение

​Шаблон отключен

​Запрос

​Ответ

​Пояснение

​Шаблон ожидает удаления

​Запрос

​Ответ

​Пояснение

​Шаблон архивирован

​Запрос

​Ответ

​Пояснение

​Шаблон разархивирован

​Запрос

​Ответ

​Пояснение

​Обновление категории шаблона

​Запрос

​Ответ

​Пояснение

​Определение категории Utility Direct Send

​Запрос

​Ответ

​Пояснение

​Обновление качества шаблона

​Запрос

​Ответ

​Пояснение

Что это такое

Перед началом работы

Как это работает

Запрос

Ответ

Шаблон одобрен

Запрос

Ответ

Пояснение

Шаблон отклонен

Запрос

Ответ

Пояснение

Шаблон приостановлен

Запрос

Ответ

Пояснение

Шаблон помечен

Запрос

Ответ

Пояснение

Шаблон отключен

Запрос

Ответ

Пояснение

Шаблон ожидает удаления

Запрос

Ответ

Пояснение

Шаблон архивирован

Запрос

Ответ

Пояснение

Шаблон разархивирован

Запрос

Ответ

Пояснение

Обновление категории шаблона

Запрос

Ответ

Пояснение

Определение категории Utility Direct Send

Запрос

Ответ

Пояснение

Обновление качества шаблона

Запрос

Ответ

Пояснение