XF 2.3 Автоматизируйте рабочие процессы с помощью вебхуков

XFI Bot · 17 Окт 2023

Настройка XenForo для отправки вебхуков

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

У Вас недостаточно прав для просмотра ссылок. Вход или Регистрация

.

Вы можете найти вебхуки в панели управления администратора в разделе «Настройка» > «Вебхуки». Чтобы создать свой первый вебхук, нажмите «Добавить вебхук». Страница добавления примерно разделена на три части. Первый позволяет вам определить важные значения, такие как заголовок и target URL-адрес:

Target URL-адрес — это URL-адрес скрипта/сервиса, который получит ваш вебхук.

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

Прокрутив немного вниз, вы увидите список типов контента:

Здесь вы можете указать одно или несколько событий для разных типов контента, для которых вы хотите активировать вебхуки. Когда вы расширяете тип контента, вы столкнетесь с несколькими вариантами. Прежде всего, вам нужно принять решение относительно того, какие события вы хотели бы запускать вебхуком.

Для каждого типа контента вы можете либо не отправлять какие-либо события, отправлять все события или отправлять только определенные события.

В этом примере мы будем отправлять только на thread_insert .

Некоторые типы контента также позволяют указать дополнительные критерии фильтрации. Например, вас могут интересовать только темы, размещенные на определенном форуме.

Третий раздел — это последние несколько настроек, которые вы можете изменить перед сохранением:

Вы можете изменить способ кодирования вебхука. По умолчанию это так, application/json но вы также можете использовать его x-www-form-urlencoded вместо этого.

Вы можете отключить здесь «Включить проверку SSL», если вам необходимо, но по большей части вы оставите это включенным, если у вас нет конкретной причины.

Наконец, вы можете установить вебхук в активное/неактивное состояние.

Как только это будет сохранено, все, что останется сделать, это опубликовать новую тему, чтобы активировать вебхук, а затем использовать webhook.site, чтобы увидеть, какие данные мы отправили... вот они!

JSON:

{
  "content_type": "thread",
  "event": "insert",
  "content_id": 216847,
  "data": {
    "custom_fields": {},
    "discussion_open": true,
    "discussion_state": "visible",
    "discussion_type": "article",
    "first_post_id": 1649025,
    "first_post_reaction_score": 0,
    "FirstPost": {
      "attach_count": 0,
      "is_first_post": true,
      "is_last_post": true,
      "is_reacted_to": false,
      "last_edit_date": 0,
      "message": "[COLOR=rgb(224, 224, 224)]Welcome to the first in our Have you seen...? series for XenForo 3.0\n\n[MEDIA=youtube]dQw4w9WgXcQ[/MEDIA][/COLOR]",
      "message_parsed": "<span style=\"color: rgb(224, 224, 224)\">Welcome to the first in our Have you seen...? series for XenForo 3.0<br />\n<br />\n<div data-template-name=\"_media_site_embed_youtube\" class=\"bbMediaWrapper\" data-media-site-id=\"youtube\" data-media-key=\"dQw4w9WgXcQ\">\n\t<div class=\"bbMediaWrapper-inner\">\n\t\t<iframe src=\"https://www.youtube.com/embed/dQw4w9WgXcQ?wmode=opaque\"\n\t\t\t\tloading=\"lazy\"\n\t\t\t\twidth=\"560\" height=\"315\"\n\t\t\t\tframeborder=\"0\" allowfullscreen=\"true\"></iframe>\n\t</div>\n</div></span>",
      "message_state": "visible",
      "position": 0,
      "post_date": 1697446950,
      "post_id": 1649025,
      "reaction_score": 0,
      "thread_id": 216847,
      "User": {
        "avatar_urls": {
          "o": "https://xenforo.com/community/data/avatars/o/11/11388.jpg?1696499135",
          "h": "https://xenforo.com/community/data/avatars/h/11/11388.jpg?1696499135",
          "l": "https://xenforo.com/community/data/avatars/l/11/11388.jpg?1696499135",
          "m": "https://xenforo.com/community/data/avatars/m/11/11388.jpg?1696499135",
          "s": "https://xenforo.com/community/data/avatars/s/11/11388.jpg?1696499135"
        },
        "is_staff": true,
        "location": "UK",
        "message_count": 33705,
        "profile_banner_urls": {
          "l": "https://xenforo.com/community/data/profile_banners/l/11/11388.jpg?1696466377",
          "m": "https://xenforo.com/community/data/profile_banners/m/11/11388.jpg?1696466377"
        },
        "question_solution_count": 98,
        "reaction_score": 40385,
        "register_date": 1318189653,
        "signature": "",
        "trophy_points": 823,
        "user_id": 11388,
        "user_title": true,
        "username": "Chris D",
        "view_url": "https://xenforo.com/community/index.php?members/chris-d.11388/",
        "vote_score": 332
      },
      "user_id": 11388,
      "username": "Chris D",
      "view_url": "https://xenforo.com/community/index.php?posts/1649025/",
      "warning_message": ""
    },
    "Forum": {
      "breadcrumbs": [
        {
          "node_id": 1,
          "title": "Official forums",
          "node_type_id": "Category"
        }
      ],
      "description": "This forum spotlights some of XenForo's interesting features. Spotlights on features in upcoming releases will be posted here.",
      "display_in_list": true,
      "display_order": 200,
      "image_url": "",
      "node_id": 3,
      "node_name": "have-you-seen",
      "node_type_id": "Forum",
      "parent_node_id": 1,
      "title": "Have you seen...?",
      "type_data": {
        "allow_posting": true,
        "article": {
          "display_style": "preview",
          "expanded_snippet": 250,
          "expanded_per_page": 13
        },
        "can_create_thread": true,
        "can_upload_attachment": true,
        "discussion_count": 135,
        "forum_type_id": "article",
        "is_unread": true,
        "last_post_date": 1697446950,
        "last_post_id": 1649025,
        "last_post_username": "Chris D",
        "last_thread_id": 216847,
        "last_thread_prefix_id": 0,
        "last_thread_title": "What's new in XenForo 3.0?",
        "message_count": 18398,
        "min_tags": 0,
        "require_prefix": false
      },
      "view_url": "https://xenforo.com/community/index.php?forums/have-you-seen/"
    },
    "highlighted_post_ids": [],
    "is_first_post_pinned": true,
    "is_search_engine_indexable": true,
    "last_post_date": 1697446950,
    "last_post_id": 1649025,
    "last_post_user_id": 11388,
    "last_post_username": "Chris D",
    "node_id": 3,
    "post_date": 1697446950,
    "prefix_id": 0,
    "reply_count": 0,
    "sticky": false,
    "tags": [],
    "thread_id": 216847,
    "title": "What's new in XenForo 3.0?",
    "User": {
      "avatar_urls": {
        "o": "https://xenforo.com/community/data/avatars/o/11/11388.jpg?1696499135",
        "h": "https://xenforo.com/community/data/avatars/h/11/11388.jpg?1696499135",
        "l": "https://xenforo.com/community/data/avatars/l/11/11388.jpg?1696499135",
        "m": "https://xenforo.com/community/data/avatars/m/11/11388.jpg?1696499135",
        "s": "https://xenforo.com/community/data/avatars/s/11/11388.jpg?1696499135"
      },
      "is_staff": true,
      "location": "UK",
      "message_count": 33705,
      "profile_banner_urls": {
        "l": "https://xenforo.com/community/data/profile_banners/l/11/11388.jpg?1696466377",
        "m": "https://xenforo.com/community/data/profile_banners/m/11/11388.jpg?1696466377"
      },
      "question_solution_count": 98,
      "reaction_score": 40385,
      "register_date": 1318189653,
      "signature": "",
      "trophy_points": 823,
      "user_id": 11388,
      "user_title": true,
      "username": "Chris D",
      "view_url": "https://xenforo.com/community/index.php?members/chris-d.11388/",
      "vote_score": 332
    },
    "user_id": 11388,
    "username": "Chris D",
    "view_count": 0,
    "view_url": "https://xenforo.com/community/index.php?threads/whats-new-in-xenforo-3-0.216847/"
  }
}

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

На верхнем уровне результатов вебхука вы увидите ключи и

content_type, а остальные данные, относящиеся к содержимому, находятся под ключом. Запрос вебхука также включает в заголовки различную информацию: [ICODE]event

content_id data

Здесь вы можете увидеть секретное значение вебхука, а также несколько дополнительных заголовков, которые вы можете использовать, если хотите, перед анализом всего содержимого, например xf-webhook-event и xf-content-type.

Это все очень круто, но давайте посмотрим, как вы можете использовать это в реальном мире.

XFI Bot · 17 Окт 2023

Реальный пример вебхука

Для целей этого примера мы собираемся использовать

У Вас недостаточно прав для просмотра ссылок. Вход или Регистрация

, но вы можете добиться аналогичных результатов с помощью IFTTT и Zapier.

Теперь мы собираемся автоматически публиковать сообщение на канале сервера Discord при создании новой темы на форуме объявлений.

В редакторе сценариев «Создать» мы нажмем кнопку «Добавить», найдем приложение «Вебхуки» и затем выберем триггер «Пользовательский вебхук»:

Затем мы нажимаем «Создать вебхук» и заполняем некоторые основные данные. Здесь вы можете указать ограничения по IP в качестве меры безопасности:

Вместо того, чтобы указывать здесь IP-адрес, давайте нажмем «Показать дополнительные настройки» и отметим «Получить заголовки запросов». Это позволит нам убедиться, что секрет вебхука, который мы отправляем вместе с запросом, верен.

Это даст вам адрес вашего вебхука. Мы изменим наш существующий вебхук, чтобы он указывал target URL-адрес на новый URL-адрес создания вебхука, и обновим фильтры, чтобы они использовали событие, thread_insert когда что-то публикуется на форуме «Объявления».

Чтобы максимально эффективно использовать возможности Make, ему необходимо понимать вашу структуру данных. Самый простой способ сделать это в этом случае — создать тестовый поток или дождаться создания нового потока.

Прежде чем настраивать секретный фильтр вебхука, мы нажмем «Добавить», чтобы добавить новый модуль, найдем «Discord» и нажмите «Отправить сообщение».

Здесь вы теперь можете настроить сервер Discord и подключиться к нему. Просто нажмите «Создать соединение», дайте ему имя и завершите процесс входа в систему, чтобы авторизовать свою учетную запись Make для подключения к вашей учетной записи Discord, выбрав целевой сервер Discord.

После авторизации бот Make (или Integromat) будет добавлен на ваш сервер. Затем вы можете вернуться в Make, чтобы точно настроить то, что вы хотите, чтобы произошло при получении вебхука.

Убедившись, что выбран вариант «Отправить сообщение на канал», вы можете указать имя своего канала в качестве цели для входящей цепочки. Вам также необходимо заполнить поле «Сообщение» тем, что вы хотите опубликовать.

Если хотите, это может быть полностью статичное сообщение, но зачем это делать, если для своего сообщения можно использовать данные из входящего вебхука?

Как только вы нажмете «ОК», это все, что вам нужно сделать. Но давайте просто взглянем на фильтры. Для этого просто нажмите на значок между двумя модулями: вебхуком и модулем Discord. Это позволяет вам «Настроить фильтр».

Мы собираемся использовать тот же секрет вебхука, который мы установили ранее, и скажем, что заголовок xf-webhook-secret должен быть равен этому. Сюда же можно добавить кучу других фильтров и условий. Хотя в XenForo вы можете указать определенные условия, например форум, вы также можете легко настроить эти фильтры в самом Make.

И все, что остается сделать, это дождаться, пока темы начнут публиковаться прямо в вашем Discord:

MrFallen · 18 Окт 2023

Нууу... Выглядит интересно, а есть какие-нибудь идеи по использованию, кроме автоматического постинга контента в соц. сети и мессенджеры?

artscripts · 18 Окт 2023

MrFallen, Все что угодно, хоть настроить мигание лампочки дома когда приходит личное сообщение.

MrFallen · 18 Окт 2023

artscripts написал(а):
@MrFallen, Все что угодно, хоть настроить мигание лампочки дома когда приходит личное сообщение.

Запуск робота пылесоса если кто-то на форуме упоминает Лолз :D

dimka1510 · 18 Окт 2023

MrFallen, на смыв унитаза лучше настроить

Sadorimatsu · 18 Окт 2023

Как по мне самый бесполезный функционал. Для кого вообще такое? Разве что тем, кто часто организовывает конкурсы, ивенты, сборы, ну может для новостных местами. Но на этом то и все, не особо то вижу применения на это... своего рода ставим тригер на определенное действие, а там и срок активности и прочее и оно всплывает в виде сообщения или иконки, как объявление. Не знаю, это типа похлопать им надо за это? Может, уже что-то полезное наконец запилят?)) Я всё не дождусь более продуманной доработки файлового менеджера и может когда-нибудь родного блога, а не костыли. Но, кто я такой, чтобы жаловаться на не интересные хотелки

Matew · 18 Окт 2023

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

Но с общем посылом вашего сообщения я согласен, 3 года явно того не стоят))

Sadorimatsu · 18 Окт 2023

Matew написал(а):
посты с форума дублировать в соцсети немного более расширенным функционалом, чем rss
Ну и интеграции со сторонними сервисами из коробки. Те же мосты с другими cms: регистрация на форуме - создание юзера в другой cms

Дублировать посты с форума в соц.сети? Нафига? 0_о вот это прям дикость. Это же вечные гулянья туда-сюда.
А вот про интеграцию по подробней можно? Что имеется в виду? И про какие сервисы речь? И про мосты на какие платформы планы? Этот вопрос меня прям заинтересовал.

Matew · 18 Окт 2023

Sadorimatsu написал(а):
Дублировать посты с форума в соц.сети? Нафига? 0_о вот это прям дикость. Это же вечные гулянья туда-сюда.

Не знаю, это с ветки на оф. форуме

Sadorimatsu написал(а):
А вот про интеграцию по подробней можно? Что имеется в виду? И про какие сервисы речь? И про мосты на какие платформы планы? Этот вопрос меня прям заинтересовал.

Это вопрос про какую-то конкретику в ещё не вышедшем обновлении. Какие сервисы? Любые сервисы, у которых есть API и которые вам нужны для каких-либо действий. А что это за сервисы, зависит уже исключительно от вас
И на текущий момент это все абстрактно, а не конкретно

XF 2.3 Автоматизируйте рабочие процессы с помощью вебхуков

XFI Bot

Настройка XenForo для отправки вебхуков

XFI Bot

Реальный пример вебхука

MrFallen

artscripts

Реклама, support, вопросы по проекту

MrFallen

dimka1510

Sadorimatsu

Matew

Sadorimatsu

Matew

Похожие темы

Мы ценим вашу конфиденциальность

XF 2.3 Автоматизируйте рабочие процессы с помощью вебхуков

Настройка XenForo для отправки вебхуков​

Реальный пример вебхука​

Реклама, support, вопросы по проекту

Похожие темы

Мы ценим вашу конфиденциальность

Настройка XenForo для отправки вебхуков

Реальный пример вебхука