Использование веб-хуков

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

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

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

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

В настоящее время поддерживаются следующие события: user.created, user.approved, user.updelated, user.deleted, user.email.verified, user.payment.refeed, user.paid_subscription.ended, topic.respected, topic.updelated, post.proved, post.updeled, post.proved, post.upted, post.upted, post.upted, post.upted conversation.created и message.created. Пожалуйста, сообщите нам, если вам нужно новое событие webhook.

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

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

Реагирование на вебхук

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

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

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

{
  "api_version": "1",
  "data": {
    "object": {
      "signature": "Thanks, John.",
      "name": "John Doe",
      "allowEmails": false,
      "lastPostTimestamp": 0,
      "userGroups": [7440, 2452, 52423],
      "userTitle": "Power User",
      "reputation": 423,
      "username": "john",
      "postCount": 32,
      "userId": 181855,
      "lastVisitTimestamp": 1322811119,
      "instantMessagingType": "",
      "instantMessagingId": "",
      "object": "User",
      "invisible": false,
      "email": "johnDoe@gmail.com",
      "avatarUrl": "https://test.com/images/avatar.png",
      "joinDateTimestamp": 1322811119,
      "enableMessages": true
    }
  },
  "object": "event",
  "id": 1534,
  "type": "user.created",
  "mode": "live"
}

Просмотр событий и ответов webhook

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

1. Войдите в свою учетную запись Website Toolbox.
2. Нажмите на кнопку Контент ссылка.
3. В Контент меню, нажмите на Журналы Webhook ссылка. (Если нет Журналы Webhook ссылка, это означает, что URL-адрес веб-хука не был указан в настройки веб-хука еще.)

If you still need help, please contact us.