Як використовувати вебхуки Snov.io

Зміст:

• Що таке вебхуки
• Параметри вебхуків Snov.io
• Як підписатися на вебхуки через Snov.io API
• Як керувати вебхуками за допомогою Snov.io API

Вебхуки — це спосіб спілкування програм між собою. Простіше кажучи, це сповіщення, яке одна програма надсилає іншій, коли трапляється завчасно визначена подія:

• Одна програма запускає вебхук, коли трапляється вибрана подія
• Інша програма отримує інформацію про подію в режимі реального часу

Наприклад, коли отримувач відповідає на емейл з розсилки, вебхук надсилається на вказану URL-адресу кінцевої точки. Потім кінцева точка може виконувати дії на основі інформації, отриманої від вебхука. Це створює можливості для налаштування автоматизованих інтеграцій.

За допомогою вебхуків Snov.io ви можете:

• інтегрувати власний додаток в Snov.io;
• отримувати сповіщення про події або дії, які трапилися у вашому акаунті Snov.io;
• надсилати дані зі Snov.io у вашу програму в режимі реального часу.

Наразі в Snov.io доступні три вебхуки (ми вже працюємо над додаванням нових):

Campaign email sent (емейл надіслано)
Snov.io надішле вебхук після відправки емейлу з тригерної розсилки. Ви можете вибрати, коли ви хочете отримувати вебхук: коли контакту буде надіслано тільки перший емейл або після кожного.

Campaign reply received (отримано відповідь на емейл з розсилки)
Snov.io надішле вебхук, коли ви отримаєте відповідь на свою тригерну розсилку. Ви можете вибрати, коли його отримати: після отримання першої відповіді або після кожної отриманої відповіді.

Campaign email opened (перегляд емейлу з розсилки)
Snov.io надішле вебхук, коли отримувач відкриє емейл в будь-якій розсилці. Вебхук міститиме таку інформацію:

• email-адреса отримувача;
• час, коли сталася подія;
• назва розсилки, в межах якої було переглянуто емейл;
• тема листа, який було відкрито;
• текст переглянутого емейлу.

Параметри вебхуків Snov.io

Параметри вебхука містять такі дані:

• Object: обʼєкт, над яким виконується дія, тобто компонент Snov.io, який повʼязаний з вебхуком (емейл, відповідь, потенційний клієнт, угода).
• Action: дія, що виконується над обʼєктом, тобто дія, що активує вебхук.
• Endpoint: URL-адреса, на яку надсилається вебхук.

Нижче наведено список доступних на даний момент обʼєктів та дій:

Як підписатися на вебхуки через Snov.io API

Щоб побачити, як працюють вебхуки в режимі реального часу, давайте скористаємося Postman та будь-яким з онлайн-генераторів кінцевих точок.

1) Підготуйте середовище для тестування API та отримайте токен доступу API

• Зареєструйтеся в Postman
• Отримайте токен доступу API
• Підготуйте API виклик та автентифікуйте його за допомогою токену доступу

Ознайомтеся з детальною інструкцією щодо автентифікації виклику Snov.io API та використання Postman для викликів API.

2) Отримайте URL-адресу кінцевої точки

Для прикладу скористаймося Beeceptor для створення безплатної кінцевої точки. На їхньому вебсайті введіть будь-яку назву кінцевої точки та натисніть «Create Endpoint».

Ви отримаєте URL-адресу кінцевої точки, на яку буде надіслано вебхук і дані, повʼязані з подією в Snov.io. Збережіть або скопіюйте цю URL-адресу, щоб скористатися нею на наступному кроці.

3) Підпишіться на вебхук через виклик API

Використовуйте наведені нижче налаштування, щоб здійснити виклик API у Postman або будь-якому іншому середовищі тестування API на ваш вибір:

• Type: POST
• URL-адреса запиту: https://api.snov.io/v2/webhooks
• Вхідні параметри:

Після того, як ви ввели всі параметри, натисніть «Send». Ви побачите таку відповідь:

“status”: “active” означає, що ви успішно підписалися на вебхук.

4) Перевірте сповіщення вебхуку за URL-адресою кінцевої точки

Вважається, що кінцева точка успішно отримала вебхук, якщо вона повертає код відповіді “HTTP 200 OK” протягом 3 секунд.

Якщо так не стається, ми робимо кілька спроб повторно надіслати вебхук:

1-а: одразу після події

2-а: через 20 хвилин після останньої спроби (20 хвилин після події)

3-я: через 40 хвилин після останньої спроби (1 година після події)

4-а: через 60 хвилин після останньої спроби (2 години після події)

5-а: через 4 години після останньої спроби (6 годин після події)

6-а: через 8 годин після останньої спроби (14 годин після події)

7-а: через 24 години після останньої спроби (38 годин після події)

Якщо всі 7 спроб не були успішними, вебхук деактивується.

Поверніться до Beeceptor і знайдіть запис POST з даними вебхуку Snov.io. Ось як це виглядає:

Після того, як ви підписалися на вебхук, щоразу, коли вибрана подія траплятиметься у вашому акаунті Snov.io, дані, повʼязані з подією, миттєво передаватимуться до кінцевої точки.

Як керувати вебхуками за допомогою Snov.io API

Переглянути список всіх створених вебхуків

• Type: GET
• URL-адреса запиту: https://api.snov.io/v2/webhooks
• Вхідні параметри: у цього методу немає вхідних параметрів.

Скасувати підписку на вебхук

Видаляє вибраний вебхук.

Містить унікальне значення id вибраного вебхуку в кінці URL запиту.

Скористайтеся методом «Список всіх вебхуків», щоб отримати значення вебхуків.

• Type: DELETE
• URL-адреса запиту: https://api.snov.io/v2/webhooks/webhook_id
• Вхідні параметри: у цього методу немає вхідних параметрів.
• Приклад URL-адреси запиту: https://api.snov.io/v2/webhooks/8

Змінити статус вебхуку

Змінює статус підписки вибраного вебхуку.

Містить унікальне значення id вибраного вебхуку в кінці запиту URL-адреси запиту.

Скористайтеся методом «Список всіх вебхуків», щоб отримати значення вебхуків.

• Type: PUT
• URL-адреса запиту: https://api.snov.io/v2/webhooks
• Вхідні параметри:

• Приклад URL-адреси запиту: https://api.snov.io/v2/webhooks/14

Зверніть увагу: ви можете налаштувати до 50 вебхуків. Вони доступні лише на преміум-акаунтах Snov.io.

Апгрейдніть свій акаунт вже зараз, отримайте доступ до інших інструментів Snov.io та підпишіться на вебхуки!