Основные понятия и настройка

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

Например, у вас есть бот в Telegram, который отправляет зрителям ссылки для покупки билетов. Когда зритель оплачивает заказ, вы получаете уведомление и, узнав id пользователя в Telegram, сможете отправить ему билет прямо в чат.

Вебхуки отправляются только в случае оплаты заказа клиентом, это статус order_done

Вебхук представляет собой POST запрос вида:

{
"type": str,
"data": object,
"refs": object,  // optional
}

Пример вебхука

Ссылка на пример

Передача дополнительных параметров из виджета оплаты

Также можно передать в вебхук дополнительные параметры, например, номер заказа или другую информацию

Для этого добавьте в адрес виджета query-параметры:

vendor_data.order_id=[id_заказа] — опционально, используется только для хранения id заказа из цифр и букв, максимум 64 символа.
vendor_data.raw.[имя_поля]=[значение_поля] — можно добавить сколько удобно, при условии уникальных имен полей, хранит произвольные данные.

Эти параметры появятся в объекте «vendor_data», который расположен в массиве «data» в вебхуке.

Пример ссылки на виджет с использованием дополнительных параметров:

https://ticketscloud.com/v1/widgets/common?token=eyJhbGciOiJIUzI1NiIsImlzcyI6InRpY2tldHNjbG91ZC5ydSIsInR5cCI6IkpXVCJ9.eyJwIjoiNWNkZDMwMGIzYzczOGQwMDBjYmUzYzIzIn0.sVmnugJFVBkHQCDiBbiVHwDAIC1g_npme3XwriEISLw&lang=ru&event=65de19da730efc49660f8399&s=1&vendor_data.raw.some_field_name=test&vendor_data.raw.another_field_name=loremipsum

Как настроить интеграцию?

Шаг 1. Зайдите в личный кабинет Ticketscloud и в меню слева выберите раздел «Интеграции». В открывшемся окне в разделе «Собственные интеграции» выберите «Вебхуки» и нажмите «Добавить».

Шаг 2. В открывшемся окне добавьте URL страницы, на который будут отправляться оповещения об оплаченных заказах

Что можно узнать про добавленные вебхуки

В интеграциях, как на скриншоте выше, нажмите «К списку добавленных вебхуков». При нажатии на неё откроется страница со списком хуков

Нажав на стрелочку рядом с хуком, у него появятся три кнопки:

«Показать данные» — показывает данные, которые были переданы в хуке;
«Показать лог» — показывает наши логи, связанные с этим хуком;
«Переотправить» — переотправляет хук.