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

У цій статті ви дізнаєтеся як налаштовувати та керувати вебхуками через Snov.io API для кастомних інтеграцій.

Що таке вебхук

Вебхуки дозволяють отримувати сповіщення про події, які відбуваються у ваших кампаніях, наприклад відповіді контактів або завершення кампанії.

Коли відбувається подія, на яку ви підписалися, Snov.io надсилає дані, пов’язані з цією подією, на вашу кінцеву точку (URL вебхука) в режимі реального часу. Ви можете використовувати ці дані для інтеграцій або автоматизацій за допомогою таких застосунків як Zapier або Make.

Використання вебхуків доступне лише на платних планах Snov.io (преміум). Ви можете створити до 50 вебхуків.

Як створити вебхуки

Щоб підписатися на вебхуки, потрібно вибрати подію, яку ви хочете відстежувати, підготувати URL-адресу кінцевої точки та надіслати запит до Snov.io API.

Виберіть події

Оберіть подію, яку ви хочете відстежувати, зі списку підтримуваних подій.

Коли вибрана подія відбудеться, Snov.io автоматично надішле дані про цю подію на вашу кінцеву точку.

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

Підготуйте URL-адресу кінцевої точки

Це ваша публічна URL-адреса, яка може приймати вхідні HTTP-запити. Наприклад, URL-адреса вебхука в Zapier або Make чи кінцева точка вашого застосунку.

Надішліть запит на створення вебхука

Щоб створити вебхук у вашому акаунті Snov.io, використовуйте кінцеву точку додати вебхук у API Snov.io.

Ви можете підписуватися на вебхуки та керувати ними за допомогою набору викликів API. Детальнішу інформацію дивіться в документації API.

Надішліть запит API із такими параметрами. Параметри вебхука заздалегідь визначені залежно від типу події, яку ви хочете відстежувати.

• Метод: POST
• URL-адреса запиту: https://api.snov.io/v2/webhooks

Параметри вебхука

• event_object — те, що ви хочете відстежувати, наприклад контакт або емейл (скопіюйте відповідні значення з таблиці вище)

• event_action — конкретна подія, яка має відбутися, щоб вебхук активувався (скопіюйте відповідне значення з таблиці вище)

• endpoint_url — ваша публічна URL-адреса, на яку Snov.io надсилатиме дані

Щоб створити вебхук для відповідей контактів (коли отримувач відповідає на будь-який емейл у будь-якій кампанії), використовуйте такі параметри:

• event_object: campaign_reply
• event_action: received

Приклад змісту запиту API:

{ "event_object": "campaign_reply", "event_action": "received", "endpoint_url": "https://your-domain.com/webhooks/snov-replies" }

Перевірте чи працює вебхук

Після створення вебхука:

• Переконайтеся, що ваша кінцева точка повертає HTTP-статус 200–299 протягом 3 секунд

• Якщо кінцева точка повертає інший статус або не відповідає вчасно, Snov.io автоматично повторює спробу надсилання вебхука

Політика повторних спроб

Нижче наведено приклад того, як Snov.io передає події вебхуків на практиці.

Вебхук вважається успішно доставленим, якщо Snov.io отримує HTTP-статус у діапазоні 200–299 протягом 3 секунд.

Якщо отримано будь-який інший HTTP-статус або виникає тайм-аут, Snov.io виконує 7 повторних спроб з поступовим збільшенням інтервалів — до 38 годин після події, яка активувала вебхук:

• 1-а: одразу після події
• 2-а: через 20 хвилин після останньої спроби (20 хвилин після події)
• 3-я: через 40 хвилин після останньої спроби (1 година після події)
• 4-а: через 60 хвилин після останньої спроби (2 години після події)
• 5-а: через 4 години після останньої спроби (6 годин після події)
• 6-а: через 8 годин після останньої спроби (14 годин після події)
• 7-а: через 24 години після останньої спроби (38 годин після події

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