Используйте веб-хуки, чтобы получать уведомления о событиях, происходящих на вашем форуме.

Когда происходит событие (например, когда новый пользователь создает учетную запись на вашем форуме), Website Toolbox создает объект Event. Этот объект содержит всю необходимую информацию о том, что только что произошло, включая тип события и данные, связанные с этим событием. Затем мы отправляем объект Event в формате JSON на ваш URL-адрес веб-хука с помощью запроса HTTP POST.

Webhooks отлично работают в сочетании с API форума. Например, веб-хук может уведомлять ваше приложение, когда новый пользователь регистрируется на вашем форуме, а затем вы можете использовать API для внесения изменений в учетную запись этого пользователя на форуме.

Для использования этой функции требуется план форума Growth или Pro.

Настройка параметров веб-хука

1. Войдите в свою учетную запись Website Toolbox.
2. Нажмите кнопку Интегрировать ссылка.
3. Нажмите кнопку Вебхук ссылка.
4. Нажмите кнопку Добавить веб-хук кнопка.
5. Введите URL-адрес веб-хука и выберите события, которые хотите получать.
6. Нажмите Сохранить.

Можно создать несколько веб-хуков для отправки событий на разные URL-адреса. Каждый веб-хук можно настроить для получения различных типов событий.

Ответ на веб-хук

Посмотрите наш пример кода для получения события webhook.

Чтобы подтвердить получение веб-хука, ваша конечная точка должна вернуть код состояния HTTP 2xx. Любая другая информация, возвращаемая в заголовках или теле запроса, игнорируется. Все коды ответов за пределами этого диапазона, включая коды 3xx, будут означать, что вы не получили веб-хук. Это означает, что перенаправление URL-адреса или ответ «Не изменено» будут расценены как сбой.

Если веб-хук по какой-либо причине не будет успешно получен, мы продолжим пытаться отправлять веб-хук один раз в час в течение 3 дней.

Пример события

{
 «версия api_»: «1»,
 «данные»: {
 «объект»: {
 «подпись»: «Спасибо, Джон. «,
 «имя»: «Джон Доу»,
 «Разрешить электронные письма»: ложь,
 «Отметка времени последнего поста»: 0,
 «Группы пользователей»: [7440, 2452, 52423],
 «Заголовок пользователя»: «Опытный пользователь»,
 «репутация»: 423,
 «имя пользователя»: «john»,
 «Количество сообщений»: 32,
 «Идентификатор пользователя»: 181855,
 «Отметка времени последнего посещения»: 1322811119,
 «Тип мгновенного сообщения»: «»,
 «Идентификатор мгновенного сообщения»: «»,
 «объект»: «Пользователь»,
 «невидимый»: ложь,
 «электронная почта»: "johnDoe@gmail.com «,
 «URL-адрес аватара»: "https://test.com/images/avatar.png «,
 «Отметка даты и времени соединения»: 1322811119,
 «Включить сообщения»: правда
 }
 },
 «объект»: «событие»,
 «идентификатор»: 1534,
 «тип»: «пользователь создан»,
 «режим»: «живой»
}

Просмотр событий и ответов на веб-хук

Вы можете просмотреть события, отправленные на ваш веб-хук, и ответ, полученный от веб-хука, следуя приведенным ниже инструкциям:

1. Войдите в свою учетную запись Website Toolbox.
2. Нажмите кнопку Интегрировать ссылка.
3. Нажмите кнопку Вебхук ссылка.
4. Нажмите на количество событий для веб-хука, которое вы хотите просмотреть.

Каждая запись в списке показывает, что это было за событие и когда оно было отправлено. Нажмите на событие, чтобы увидеть отправленную полезную информацию и ответ, полученный от вашего веб-хука.

События Webhook и ответы на них хранятся в течение 30 дней.