Вебхук – це спеціальний код, за допомогою якого можна відслідкувати зміни на одному ресурсі та передати їх на інший ресурс у реальному часі.
Вебхуки в Uspacy – це спосіб автоматизувати роботу у Просторі. А саме автоматично «сигналізувати» про певні події, які відбуваються в Uspacy, стороннім сервісам.
Уся робота з вебхуками відбувається на однойменній сторінці Простору. Щоб перейти на неї потрібно розгорнути розділ Автоматизація.
🌟Зверніть увагу, що доступ до цього розділу мають тільки власник (суперадміністратор) і адміністратор Простору.
⚙️ Оскільки ці дії передбачають певних технічних навичок і вмінь, то радимо роботи з налаштування вебхуків проводити саме спеціалістам-розробникам. Або ж ви завжди можете звернутися за допомогою до наших партнерів.
Як створити новий вебхук?
Щоб зробити це, натисніть на однойменну кнопку.
Відкриється вікно, де потрібно бути заповнити всі поля. Вибрати що саме та з яким об’єктом буде відбуватися, щоб на основі цих змін надіслати дані за межі Uspacy стороннім сервісам.
Подія – що саме повинно статися. Тобто, вебхук відпрацює, коли буде створено, змінено, видалено об’єкт чи змінено етап для нього.
Об’єкт події – те, з чим відбувається взаємодія. Тобто вебхук відпрацює, коли певну сутність, а саме лід, угоду, контакт, компанію, справу, завдання, допис чи коментар буде створено, змінено, видалено чи змінено етап для них.
❗️Зверніть увагу, що деякі сутності є несумісними з деякими подіями. Наприклад, не можна створити вебхук, який буде надсилати дані про зміну етапу для контакту, компанії, справи тощо. Оскільки це неможливо, спираючись на функціонал цих сутностей.
Активність – забезпечує роботу вебхука, після його підтвердження.
Кінцева точка за межами Uspacy – URL-адреса, на яку потрібно надсилати дані. Там розробник розміщує спеціальний код, який буде обробляти вхідні запити (повідомлення).
💡Ця адреса повинна бути дійсною та загальнодоступною. У полі її потрібно обов'язково прописувати з https://. Тобто https://MN.XY, де https:// – протокол, MN.XY – доменне ім'я.
Коли всі поля заповнені, натисніть Створити.
Вебхук одразу буде додано до загального переліку. Спочатку він отримає статус Непідтверджений. Тому, щоб вебхук почав коректно працювати потрібно його підтвердити. ⬇️
Як підтвердити вебхук?
Після створення вебхуку Uspacy надішле POST-запит на вашу URL-адресу кінцевої точки з підтверджувальним посиланням.
А ваш сервер повинен прийняти цей запит, видобути це посилання та перейти по ньому.
Готово ✅
Після цього вебхук отримає статус Підтверджений і буде працювати.
Корисні посилання та поради
Для підтвердження та обробки вхідних повідомлень можна використовувати готові хендлери Amazon SNS для різних мов та фреймворків.
🔍 PHP/Laravel: https://github.com/nipwaayoni/laravel-aws-sns
🔍 Python/Django https://gist.github.com/gaqzi/d3cf5e73afb42e535376
Приклад повідомлення про подію
{
"topic": "Notifications",
"type": "comment",
"env": "prod",
"data": {
"entity": {
"author_id": 1,
"entity_type": "task",
"entity_id": 786,
"message": "<p class=\"PlaygroundEditorTheme__paragraph\" dir=\"ltr\"><span>test<\/span><\/p>",
"date": 1690963631,
"id": 9087,
"mentioned": {
"users": [],
"departments": [],
"groups": []
},
"notify": {
"users": [
1
],
"groups": [],
"departments": []
}
},
"user_id": 1,
"service": "comments",
"domain": "my.uspacy.ua",
"timestamp": "2023-08-02T08:07:11.256570Z",
"action": "create"
},
"metadata": []
}