Як налаштувати відправку вебхуків до себе в систему

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

Для чого можна використовувати відправку вебхука

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

Наприклад, ліди залишають заявки у вас на сайті, їх контактні дані потрапляють у вашу CRM-систему та синхронізуються із SendPulse. За цими лідами стартує ланцюжок Automation 360 для подальшого прогріву. Ви хочете продзвонювати всім, хто відкрив третій лист із ланцюжка. Для цього необхідно змінити статус лідів у вашій CRM. Саме за допомогою вебхука ви можете це зробити, відправивши у вашу систему дані про подію для підписника.

Як включити відправку вебхука в авторозсилку

Щоб надсилати оповіщення про події в іншу систему, додайте блок Дія (Action) — Надіслати вебхук (Send webhook) за блоком, подію з якого ви хочете відстежувати. Відстежувати можна отримання або відкриття листа, проходження фільтрації за заданою умовою, досягнення мети або будь-яку іншу дію, вчинену підписником у межах ланцюжка авторозсилки.

Вкажіть назву вебхука та URL, на який буде надсилатись вебхук. У назві вебхука дозволено використовувати лише цифри та латинські символи.

Налаштуйте відправку ключа у відповідь на перший вебхук, щоб зняти ліміт на відправлення веб-хуків. У іншому випадку сервіс дозволить відправляти максимум один вебхук за годину.

Коли ланцюжок авторозсилки готовий, натисніть Зберегти та вийти (Save and Exit), щоб зберегти його, або Зберегти та запустити (Save and Start), щоб зберегти розсилку та запустити його.

Структура вебхука

Вебхук передає такі дані:

• ID ланцюжка;
• назва вебхука;
• дата спрацьовування вебхука;
• email адреса та номер телефону, для якого спрацювала відправка вебхука;
• дані змінних.

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

[
   {
      "automation_id":"123456789",
      "title":"New Automation",
      "execution_date":"2022-01-04 09:02:39",
      "email":"example@example.com",
      "phone":"+380631234567",
      "variables":[
         {
            "name1":"value1"
         },
         {
            "name2":"value2"
         }
      ]
   }
]

Як надіслати тестовий вебхук

Ви можете надіслати тестовий вебхук, щоб перевірити правильність налаштувань та виявити будь-які потенційні проблеми чи помилки. Для цього натисніть Виконати тестовий запит (Run a test request).

У діалоговому вікні, що розгортається, ви знайдете тестовий запит, включно з URL вашого сайту, сам відправлений вебхук та його відповідь.

Вебхук повертає різні відповіді залежно від параметрів запиту чи стану системи.

Відповідь вебхуку містить такі параметри:

Вебхук може повертати такі відповіді:

У разі помилки в коді:

[
   {
     "status": false,
     "message": 'Error during query execution',
     "code": 21111011
   }
]

У разі помилки під час виконання запиту:

[
   {
     "status": false,
     "message": 'The request failed',
     "code": 11110111
   }
]

У разі помилки, якщо користувач не повертає відповідь у форматі JSON:

[
   {
     "status": false,
     "message": 'Invalid response format. Expects json!',
     "code": 11110112
   }
]

У разі помилки, якщо невірний перевірочний код для безплатних користувачів:

[
   {
     "status": false,
     "message": 'The request did not pass code verification',
     "code": 11110113
   }
]

У разі помилки під час перевірки IP адреси, наприклад, якщо він заблокований або локальний:

[
   {
     "status": false,
     "message": 'Incorrect url ip',
     "code": 11110114
   }
]

У разі успіху:

[
   {
     "status": true,
     "(string)message": (webhook response),
     "code": 1
   }
]

Як відстежити відписки та скарги на спам

Відстеження відписок та скарг користувачів на спам можна увімкнути у налаштуваннях облікового запису.

Приклад вебхука скарги на спам:

[
   {
      "timestamp":1496827422,
      "event":"spam",
      "task_id":3668141,
      "email":"john.doe@sendpulse.com",
      "source":"automation360",
      "automation_id":"123456789"
   }
]

Приклад вебхука відписки:

[
   {
      "task_id":"3668141",
      "timestamp":"1496827872",
      "from_all":1,
      "email":"john.doe@sendpulse.com",
      "reason":null,
      "book_id":490686,
      "event":"unsubscribe",
      "categories":"",
      "source":"automation360",
      "automation_id":"123456789"
   }
]

Оновлено: 02.04.2024