Перший погляд на webhooks (v2)
УВАГА: Зверніть увагу, що ця функція або стаття призначена для досвідчених користувачів.
Webhook — це спосіб, за допомогою якого застосунок або програмне забезпечення на кшталт Ultimate Multisite може надавати іншим застосункам інформацію в реальному часі. Webhook доставляє дані або payloads до інших застосунків у момент події, т обто ви отримуєте дані негайно.
Це корисно, якщо вам потрібно інтегрувати або передавати певні дані з Ultimate Multisite до іншої CRM чи системи щоразу, коли спрацьовує подія. Наприклад, вам потрібно надсилати ім’я та адресу електронної пошти користувача до списку розсилки щоразу, коли створюється новий обліковий запис користувача.
Як створити webhook
Щоб створити webhook, перейдіть до панелі адміністрування мережі. Натисніть Ultimate Multisite > Webhooks > Add New Webhook.
Після цього ви можете відредагувати конфігурацію webhook:
Під час створення нового webhook вас попросять надати таку інформацію, як Name, URL, і Event. Ви можете використати будь-яку наз ву для свого webhook. Найважливіші поля — це URL і Event.
URL — це endpoint або місце призначення, до якого Ultimate Multisite надішле payload або дані. Це застосунок, який отримає дані.
Zapier — найпоширеніше рішення, яке користувач використовує, щоб полегшити інтеграцію зі стороннім застосунком. Без платформи на кшталт Zapier вам потрібно буде вручну створити власну функцію, яка перехоплюватиме дані та оброблятиме їх. Дивіться цю статтю про те, як використовувати webhook Ultimate Multisite із Zapier.
У цій статті ми розглянемо базову концепцію того, як працює webhook, і події, доступні в Ultimate Multisite. Ми будемо використовувати сторонній сайт під назвою requestbin.com. Цей сайт дозволить нам створити endpoint і перехопити payload без написання коду. Відмова від відповідальності: усе, що він зробить, — покаже нам, що дані було отримано. Жодної обробки або будь-якої дії з payload виконано не буде.
Перейдіть на requestbin.com і натисніть Create Request Bin.
Після натискання цієї кнопки вас попросять увійти, якщо у вас уже є обліковий запис, або зареєструватися. Якщо у вас уже є обліковий запис, вас одразу буде перенаправлено до їхньої панелі керування. На їхній панелі керування ви відразу побачите endpoint або URL, який можна використати під час створення вашого webhook Ultimate Multisite.
Скопіюйте URL і поверніться до Ultimate Multisite. Вставте endpoint у поле URL і виберіть подію з розкривного списку. У цьому прикладі ми виберемо Payment Received.
Ця подія спрацьовує щоразу, коли користувач здійснює платіж. Усі доступні події, їхній опис і payloads перелічені внизу сторінки. Натисніть кнопку Add New Webhook, щоб зберегти webhook.
Тепер ми можемо надіслати тестову подію до endpoint, щоб побачити, чи працює створений нами webhook. Це можна зробити, натиснувши Send Test Event під створеним нами webhook.
Це показує вікно підтвердження, у якому зазначено, що тест був успішним.
Тепер, якщо ми повернемося на сайт Requestbin, побачимо, що payload було отримано і він містить деякі тестові дані.
Це базовий принцип того, як працюють webhook і endpoints. Якщо ви створюватимете власний endpoint, вам потрібно буде створити власну функцію для обробки даних, які ви отримуєте від Ultimate Multisite.