Первый взгляд на Webhooks (v2)
ВНИМАНИЕ: обратите внимание, что эта функция или статья предназначена для опытных пользователей.
webhook — это способ, с помощью которого приложение или программное обеспечение, например Ultimate Multisite, предоставляет другим приложениям информацию в реальном времени. Webhook доставляет данные или полезную нагрузку другим приложениям по мере наступления события, то есть вы получаете данные немедленно.
Это полезно, если вам нужно интегрировать или передавать определенные данные из Ultimate Multisite в другую CRM или систему каждый раз, когда срабатывает событие. Например, вам нужно отправлять имя пользователя и адрес электронной почты в список рассылки каждый раз, когда создается новая учетная запись пользователя.
Как создать webhook
Чтобы создать webhook, перейдите в панель администратора сети. Нажмите Ultimate Multisite > Webhooks > Add New Webhook.
Затем вы можете отредактировать конфигурацию webhook:
При создании нового webhook у вас запросят такую информацию, как Name, URL, и Event. Вы можете использовать любое имя для своего webhook. Самые важные поля — это URL и Event.
URL — это endpoint или место назначения, куда Ultimate Multisite отправит полезную нагрузку или данные. Это приложение, которое получит данные.
Zapier — самое распространенное решение, которое пользователь использует, чтобы упростить интеграцию со сторонним приложением. Без платформы вроде Zapier вам потребуется вручную создать пользовательскую функцию, которая будет перехватывать данные и обрабатывать их. См. эту статью о том, как использовать Ultimate Multisite webhook с Zapier.
В этой статье мы рассмотрим базовую концепцию того, как работает webhook, и события, доступные в Ultimate Multisite. Мы будем использовать сторонний сайт requestbin.com. Этот сайт позволит нам создать endpoint и перехватить полезную нагрузку без написания кода. Отказ от ответственности: все, что он сделает, — покажет нам, что данные были получены. Обработки или какого-либо действия с полезной нагрузкой не будет.
Перейдите на requestbin.com и нажмите Create Request Bin.
После нажатия этой кнопки вам будет предложено войти в систему, если у вас уже есть учетная запись, или зарегистрироваться. Если у вас уже есть учетная запись, вас сразу перенаправит в их Dashboard. В их Dashboard вы сразу увидите endpoint или URL, который можно использовать при создании вашего Ultimate Multisite webhook.
Скопируйте URL и вернитесь в Ultimate Multisite. Поместите endpoint в поле URL и выберите событие из раскрывающегося списка. В этом примере мы выберем Payment Received.
Это событие срабатывает всякий раз, когда пользователь совершает платеж. Все доступные события, их описания и полезные нагрузки перечислены внизу страницы. Нажмите кнопку Add New Webhook, чтобы сохранить webhook.
Теперь мы можем отправить тестовое событие на endpoint, чтобы убедиться, что созданный нами webhook работает. Мы м ожем сделать это, нажав Send Test Event под созданным webhook.
Появится окно подтверждения, сообщающее, что тест прошел успешно.
Теперь, если мы вернемся на сайт Requestbin, мы увидим, что полезная нагрузка была получена и содержит некоторые тестовые данные.
Это базовый принцип работы webhook и endpoints. Если вы собираетесь создать пользовательский endpoint, вам потребуется создать пользовательскую функцию для обработки данных, которые вы получаете из Ultimate Multisite.