Примеры Webhook

Ищите событие по его точному значению type. В каждом справочном описании указаны Триггеры, Синтаксис, Параметры и Пример. Этот справочник охватывает все 47 типов событий контракта Webhook YCloud. YCloud отправляет собственный конверт событий. При интеграции с YCloud используйте имена событий и поля, приведенные на этих страницах. Перед получением событий настройте конечную точку Webhook, подпишитесь на нужные типы событий и проверяйте заголовок YCloud-Signature. Используйте примеры полезной нагрузки на странице каждого события для тестирования вашего обработчика.

Общий конверт

Каждое событие содержит id, type, apiVersion и createTime. Маршрутизируйте по type и устраняйте дубликаты по id события. Поля полезной нагрузки зависят от конкретного события и сценария. Проверьте подпись и надежно примите событие перед возвратом ответа 2xx. О повторных попытках и настройке приемника см. в разделе Настройка вебхуков.

Messenger

Тип события	Триггер
`messenger.inbound_message.received`	Происходит при получении обычного текстового сообщения Messenger от клиента.
`messenger.inbound_message.updated`	Происходит, когда клиент редактирует сохраненное входящее текстовое сообщение Messenger.
`messenger.message.updated`	Происходит, когда доступен снимок сохраненного обычного исходящего сообщения Messenger, включая результаты отправки и сопоставленные отчеты о доставке.
`messenger.message_reaction.updated`	Происходит, когда клиент ставит реакцию на сообщение Messenger или удаляет ее.

Сообщения WhatsApp

Тип события	Триггер
`whatsapp.inbound_message.received`	Происходит при получении входящего сообщения WhatsApp.
`whatsapp.message.updated`	Происходит при обновлении статуса исходящего сообщения WhatsApp, когда статус меняется на `sent`, `failed`, `delivered` или `read`.
`whatsapp.user.preferences`	Происходит, когда пользователь WhatsApp отключает или возобновляет получение маркетинговых сообщений.

Шаблоны WhatsApp

Тип события	Триггер
`whatsapp.template.category_updated`	Происходит при обновлении категории шаблона WhatsApp.
`whatsapp.template.correct_category_detection`	Происходит, когда Meta обнаруживает контент неутилитарного характера в Utility Direct Send. Подпишитесь через API конечных точек Webhook.
`whatsapp.template.quality_updated`	Происходит при обновлении рейтинга качества шаблона WhatsApp.
`whatsapp.template.reviewed`	Происходит при проверке шаблона WhatsApp или изменении его жизненного цикла, включая одобрение, отклонение, приостановку, отключение, архивирование и разархивирование.

Аккаунты WhatsApp

Тип события	Триггер
`whatsapp.business_account.deleted`	Происходит при удалении WhatsApp Business Account.
`whatsapp.business_account.reviewed`	Происходит после завершения проверки WhatsApp Business Account.
`whatsapp.business_account.updated`	Происходит при нарушении политик, блокировке WhatsApp Business Account и в других подобных случаях.

Телефонные номера WhatsApp

Тип события	Триггер
`whatsapp.phone_number.deleted`	Происходит при удалении бизнес-номера телефона WhatsApp.
`whatsapp.phone_number.name_updated`	Происходит, когда отображаемое имя бизнес-номера телефона WhatsApp одобрено или отклонено.
`whatsapp.phone_number.quality_updated`	Происходит при обновлении качества, лимита сообщений или состояния подключения бизнес-номера телефона WhatsApp.
`whatsapp.phone_number.business_username_updated`	Происходит при обновлении Business Username бизнес-номера телефона WhatsApp.

WhatsApp Business App

Тип события	Триггер
`whatsapp.smb.history`	Происходит при синхронизации истории сообщений WhatsApp Business App.
`whatsapp.smb.message.created`	Происходит при отправке сообщения из WhatsApp Business App.
`whatsapp.smb.message.echoes`	Происходит, когда сообщение, отправленное из WhatsApp Business App, синхронизируется как эхо-сообщение.

Агенты WhatsApp

Тип события	Триггер
`whatsapp.echo_message.created`	Происходит, когда для Public REST API Agent регистрируется исходящее эхо-сообщение.
`whatsapp.echo_message.updated`	Происходит, когда для Public REST API Agent получен исходящий эхо-статус; также могут доставляться запоздалые статусы с более низким приоритетом.
`whatsapp.meta_business_agent.handover.updated`	Происходит, когда поддерживаемый callback передачи управления передает контроль от Public REST API Agent. Не подтверждает назначение во входящих (Inbox).

Звонки WhatsApp

Тип события	Триггер
`whatsapp.call.connect`	Происходит, когда входящий звонок предоставляет SDP offer или инициированный бизнесом звонок предоставляет SDP answer.
`whatsapp.call.terminate`	Происходит при завершении звонка WhatsApp.
`whatsapp.call.status.updated`	Происходит при обновлении статуса звонка WhatsApp.
`whatsapp.call.recording.updated`	Происходит, когда запись звонка WhatsApp, инициированного через API, становится доступной или завершается неустранимой ошибкой.
`whatsapp.call.transcription.updated`	Происходит, когда транскрипция звонка WhatsApp, инициированного через API, становится доступной или завершается неустранимой ошибкой.

Группы WhatsApp

Тип события	Триггер
`whatsapp.group.lifecycle_update`	Происходит при создании или удалении группы WhatsApp, включая успешные и неудачные результаты.
`whatsapp.group.participants_update`	Происходит при обновлении списка участников группы WhatsApp или запросов на вступление.
`whatsapp.group.settings_update`	Происходит при обновлении настроек группы WhatsApp, включая успешные и неудачные результаты.
`whatsapp.group.status_update`	Происходит при обновлении статуса блокировки группы WhatsApp.

WhatsApp Flows и платежи

Тип события	Триггер
`whatsapp.flow.status_change`	Происходит при обновлении статуса WhatsApp flow.
`whatsapp.payment.updated`	Происходит при изменении статуса платежной транзакции WhatsApp.

Контакты

Тип события	Триггер
`contact.attributes_changed`	Происходит при изменении атрибутов контакта.
`contact.created`	Происходит при создании контакта.
`contact.deleted`	Происходит при удалении контакта.
`contact.unsubscribe.created`	Происходит, когда контакт отписывается от сообщений.
`contact.unsubscribe.deleted`	Происходит, когда контакт возобновляет подписку на сообщения.
`contact.note.created`	Происходит при создании заметки о контакте.
`contact.note.updated`	Происходит при обновлении заметки о контакте.
`contact.note.deleted`	Происходит при самостоятельном удалении заметки о контакте. При каскадном удалении заметок вместе с контактом это событие не генерируется.

Email, SMS и Voice

Тип события	Триггер
`email.delivery.updated`	Происходит при обновлении статуса доставки email, когда статус меняется на `delivered` или `failed`.
`sms.message.updated`	Происходит при обновлении статуса SMS-сообщения, когда статус меняется на `delivered` или `undelivered`.
`sms.inbound.received`	Происходит при получении входящего SMS-сообщения, что означает, что пользователь ответил на ваше сообщение.
`voice.message.updated`	Происходит при обновлении статуса голосового сообщения, когда статус меняется на `delivered` или `undelivered`.

Начало работы

Руководства

Конечные точки

Webhook reference

Примеры Webhook

Общий конверт

Messenger

Сообщения WhatsApp

Шаблоны WhatsApp

Аккаунты WhatsApp

Телефонные номера WhatsApp

WhatsApp Business App

Агенты WhatsApp

Звонки WhatsApp

Группы WhatsApp

WhatsApp Flows и платежи

Контакты

Email, SMS и Voice

​Общий конверт

​Messenger

​Сообщения WhatsApp

​Шаблоны WhatsApp

​Аккаунты WhatsApp

​Телефонные номера WhatsApp

​WhatsApp Business App

​Агенты WhatsApp

​Звонки WhatsApp

​Группы WhatsApp

​WhatsApp Flows и платежи

​Контакты

​Email, SMS и Voice

Общий конверт

Messenger

Сообщения WhatsApp

Шаблоны WhatsApp

Аккаунты WhatsApp

Телефонные номера WhatsApp

WhatsApp Business App

Агенты WhatsApp

Звонки WhatsApp

Группы WhatsApp

WhatsApp Flows и платежи

Контакты

Email, SMS и Voice