Help > Forum > Интеграция веб-сайтов > Использование Webhooks

Использование Webhooks

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

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

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

В настоящее время поддерживаются следующие события: user.created, user.Утвержден, user.updated, user.deleted, user.email.verified, user.payment.get, user.paid_subscription.начат, user.paid_subscription.ended, Topic.created, Topic.updated, Topic.deleted, post.created, post.Утвержден, post.updated, post.delete, conversation.created и message.created. Пожалуйста дайте нам знать если вам нужно определенное новое событие webhook.


Настройка настроек webhook

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

Ответ на webhook

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

Если webhook не был успешно получен по какой-либо причине, мы будем продолжать пытаться отправить webhook один раз в час на срок до 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, и ответ, полученный с вашего webhook, следуя инструкциям ниже:

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


If you still need help, please contact us.