⚡ Webhook API та автоматизація

My Pie Studio надає Webhook API, який дозволяє запускати елементи оверлея із зовнішніх додатків, скриптів або обладнання на кшталт Elgato Stream Deck.

Як це працює #

Ви налаштовуєте зовнішню програму на відправку спеціальної прихованої команди до нашої системи за наданим посиланням. Оверлей миттєво реагує — показує візуальний елемент або відтворює звук.

Ваше вебхук посилання # 

POST https://mypie.studio/api/v1/studios/<ВАШ_PUBLIC_ID>/trigger_alert
💡 Примітка щодо ідентифікаторів: Ваші <PUBLIC_ID> та alert_id генеруються системою автоматично. Вам не потрібно шукати їх вручну або самостійно створювати запит — просто увімкніть вебхук для обраного елемента та скопіюйте вже готовий curl фрагмент безпосередньо з правої панелі Студії.

Параметри #

  • alert_id (обов'язковий) — Унікальний ID об'єкта, який потрібно запустити.
  • duration (необов'язковий) — Тривалість показу візуального елемента на екрані (в секундах). За замовчуванням 5. Ігнорується для аудіо.

Підтримувані елементи #

Візуальні елементи (Зображення, Текст, Таймер, Біжучий рядок, WebM)

Необхідно увімкнути перемикач "Allow Triggering via Webhook" в налаштуваннях об'єкта. Після увімкнення елемент автоматично приховується на стрімі. При спрацюванні вебхука він з'являється на налаштований duration (в секундах), потім автоматично ховається.

Аудіо-елементи

Аудіо-об'єкти не мають візуального відображення. Вебхук просто відтворює звуковий ефект на налаштованій гучності. Параметр duration ігнорується. Аудіо має бути видимим (іконка ока), щоб його можна було запустити.

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

Інструкція з налаштування #

  1. Створіть елемент Зображення, Текст або Аудіо в Студії.
  2. Виділіть елемент. На правій панелі увімкніть перемикач Allow Triggering via Webhook.
  3. Для візуальних елементів налаштуйте "Show Duration" для контролю тривалості показу.
  4. Студія генерує готову до використання команду curl — скопіюйте її з панелі редактора.
  5. Натисніть Fire Webhook Now в редакторі для миттєвого тестування. Студія автоматично публікує поточний стан перед запуском.

>_ Приклад команди cURL # 

curl -X POST https://mypie.studio/api/v1/studios/<PUBLIC_ID>/trigger_alert \
     -H "Content-Type: application/json" \
     -d '{"alert_id": "12345-abcde", "duration": 8}'

Тестування вебхуків #

🌐 Іконка Планети (Панель шарів)

Елементи в режимі Webhook показують іконку 🌐 на панелі Шарів. Натисніть для миттєвого тестового запуску. Іконка пульсує синім під час активності. Студія автоматично публікує перед запуском.

🔊 Кнопка Play (Тільки аудіо)

Аудіо-елементи мають кнопку "Play" в редакторі для локального прослуховування, та кнопку "Fire Webhook Now", яка запускає реальний API-ендпоінт на вашому оверлеї.

Сценарії автоматизації #

  • Elgato Stream Deck — Прив'яжіть кнопку до виконання наданого curl-скрипта через дію "System → Run" для відправки команди на ваш оверлей.
  • Інтеграція з чат-ботом — Налаштуйте Nightbot, Python або Node.js бота для виклику вебхука на команди типу !airhorn.
  • Комбінація Візуал + Звук — Створіть окремі елементи Зображення та Аудіо, потім запустіть обидва вебхуки одночасно для комбінованого аудіовізуального ефекту.
  • Інтеграція з іншими сервісами — Використовуйте Zapier або Make.com для автоматичної появи візуальних елементів або звуків на стрімі у відповідь на події з інших платформ.