Як підключити дію ActionJail до сценарію бота (Інтегратор)

Ця інструкція допоможе інтегрувати створену дію в сценарій, налаштувати параметри, передати дані в зовнішній API та відловити помилки, щоб сценарій працював стабільно.

Коли стане в пригоді

  • Потрібно викликати зовнішній API або власну логіку в сценарії.
  • Є готова дія в ActionJail, яку треба використати як крок бота.
  • Треба швидко замінити логіку без зміни всього сценарію.

Що важливо знати

  • Дія (action) має системний ID action_*, параметри (JSON-конфіг) і форму (UI схема).
  • Сценарій бота викликає дію як крок і передає значення параметрів.
  • Обробка помилок: варто повертати структуровану відповідь або коди помилок для сценарію.

Перед початком

  • Дія вже створена й опублікована в ActionJail.
  • Ви знаєте, які параметри потрібні зовнішньому API (ключі, URL, payload).
  • Маєте доступ до конструктора сценаріїв.

Покрокова інструкція

  1. Відкрийте конструктор сценарію бота та додайте крок виконання дії.
  2. Оберіть дію зі списку за назвою або системним ID action_*.
  3. У полі параметрів заповніть JSON-конфіг дією: передайте потрібні ключі (наприклад, url, token, payload).
  4. Вкажіть, які дані зі сценарію підставляються у параметри (ID клієнта, текст повідомлення, файл тощо).
  5. За потреби додайте гілку обробки помилки: якщо дія повертає помилку/таймаут — показати резервне повідомлення або ескалювати оператору.
  6. Збережіть сценарій і запустіть тест: виконайте дію з тестовими даними.
  7. Перевірте журнал/лог кроку: переконайтеся, що статус успішний і зовнішній API повернув очікувану відповідь.

Що відбувається після

  • Сценарій викликає дію під час виконання кроку і отримує відповідь від зовнішнього API.
  • При помилці спрацьовує резервна гілка або показується службове повідомлення.

Як переконатися, що все вдалось

  • Крок сценарію завершується без помилок, час відповіді в межах очікуваного.
  • Параметри передаються коректно (перевірте у логах значення ключових полів).
  • Зовнішній API повертає успішний статус.

Інші способи

  • Для повторного використання параметрів — створіть окрему групу або клон дії й підставляйте дефолтні значення.
  • Для тестів без зовнішнього API — тимчасово замініть URL на mock-ендпоінт.

Пов’язані інструкції