Основные понятия и настройка
Вебхуки — это уведомление в виде кода о действиях пользователях в виджете, которое мгновенно отправляется на любой указанный URL.
Например, у вас есть бот в Telegram, который отправляет зрителям ссылки для покупки билетов. Когда зритель оплачивает заказ, вы получаете уведомление и, узнав id пользователя в Telegram, сможете отправить ему билет прямо в чат.
Вебхуки отправляются на каждом этапе жизни заказа:
order_created: создание заказа
order_in_progress: переход на оплату
order_done: заказ оплачен
order_cancelled: заказ отменен (пользователем либо системой)
order_expired: у заказа истек срок для оплаты
Вебхук представляет собой POST запрос вида:
{
"type": str,
"data": object,
"refs": object, // optional
}
Пример вебхука
Пример вебхука оплаченного заказа можно скачать по ссылке: пример
Передача дополнительных параметров из виджета оплаты покупки
Вы также можете передать в вебхук дополнительные параметры, например, номер заказа или другую информацию.
Для этого необходимо добавить в адрес виджета следующие query-параметры:
vendor_data.order_id=[id_заказа] — опционально, используется только для хранения id заказа из цифр и букв, максимум 64 символа.
vendor_data.raw.[имя_поля]=[значение_поля] — можно добавить сколько удобно, при условии уникальных имен полей, хранит произвольные данные.
Эти параметры появятся в объекте "vendor_data", который расположен в массиве "data" в вебхуке.
Пример ссылки на виджет с использованием дополнительных параметров:
Как настроить интеграцию?
Шаг 1. Зайдите в личный кабинет Ticketscloud и в меню слева выберите раздел «Интеграции». В открывшемся окне в разделе «Собственные интеграции» выберите «Вебхуки» и нажмите «Добавить».
Шаг 2. В открывшемся окне добавьте URL страницы, на который будут отправляться оповещения о новых заказах.