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