Использование webhook позволит получать информацию о бронированиях в реальном времени. На каждое отслеживаемое вами событие мы посылаем webhook, без необходимости периодически опрашивать систему.
Управление webhook
Вы можете настроить до пяти перехватчиков на странице Webhooks в разделе Настройки – Для разработчиков.
На странице представлены уже ранее созданные webhook, их статус, процент неуспешных отправок и небольшой наглядный график статистики отправок за последние 7 дней:
Если на странице ещё ничего нет, и вам требуется создать новый webhook, нажмите кнопку +Добавить. Введите параметры перехватчика:
- Метод: POST (при наступлении события будет отправлен полный payload) или GET (будет отправлено короткое сообщение без сегмента Body).
- URL: адрес, по которому ваша система будет принимать webhook.
- Коды ответа: HTTP-коды, которые будут считаться за успешный результат отправки. Несколько кодов разделяются запятой.
- Описание: текстовое поле для поясняющего текста. Отображается в описании webhook для удобства, не отправляется.
В правой части страницы выберите тип отслеживаемого события: один из пяти, несколько или все доступные триггеры, после которых должен сработать webhook:
Ниже настройки оповещения об автоматическом отключении webhook при ошибках отправки:
- Задайте количество попыток отправки и интервал между ними.
- Активируйте или отключите автоматическое отключение при ошибках. Укажите адрес для уведомлении об этом или несколько адресов, разделённых запятой.
Ниже находится блок добавления кастомных параметров. Например, если для вашей системы важно наличие блока авторизации в приходящих webhook, вы можете добавить эти параметры к числу отправляемых.
История отправки
По каждому webhook ведётся подробная история отправки. Зайдите в Настройки – Для разработчиков – Webhooks, найдите в списке нужный и кликните по нему.
На открывшейся странице вы увидите краткую информацию по webhook в верхней части и подробный лог отправок в нижней. Доступна фильтрация по дате, успешности или типу события.
Выберите любую из записей, чтобы просмотреть подробности по отправленным данным. Для всех попыток доступна кнопка Повторная отправка.
Отправляемые данные
Описание используемых переменных находится в этой статье.
Особые настройки
Если требуется создать нестандартный webhook или большее количество, чем 5, обратитесь в поддержку и укажите:
- URL-адрес, на который хотите принимать уведомления об изменениях в системе.
- О каких событиях отправлять уведомления: например, создание, отмена, изменение записи.
- Какие данные интересуют: вся доступная выдача (весь payload) или выборочный набор.
- Задайте метод POST (отправлять полный payload) или GET (сообщение без сегмента Body), параметры успешной отправки, отслеживаемые события и, при необходимости, кастомные атрибуты.
Вебхуки доступны только на Профессиональном тарифе.