Webhook API & Automation

My Pie Studio provides a Webhook API that lets you trigger overlay elements from external applications, scripts, or hardware like the Elgato Stream Deck.

How It Works #

An external application sends an HTTP POST request to your unique webhook URL. The overlay reacts instantly: a visual element appears for a few seconds, or an audio clip plays.

Your Webhook Link # 

POST https://mypie.studio/api/v1/studios/<YOUR_PUBLIC_ID>/trigger_alert
Note about IDs: Both <PUBLIC_ID> and alert_id are generated automatically. You never need to look them up. Enable the webhook on an element and copy the ready-to-use curl snippet from the Studio's right-hand panel.

Parameters #

  • alert_id (required): the unique ID of the object you want to trigger.
  • duration (optional): how long (in seconds) a visual element stays on screen. Defaults to 5. Ignored for audio.

Supported Elements #

Visual Elements (Image, Text, Timer, Ticker, WebM)

You must enable the "Allow Triggering via Webhook" toggle in the object's settings. Once enabled, the element is automatically hidden on the stream. When the webhook fires, it appears for the configured duration (in seconds), then auto-hides again.

Audio Elements

Audio objects have no visual representation. The webhook simply plays the sound effect at its configured volume. The duration parameter is ignored. Audio must be set to visible (eye icon) to be triggerable.

Note: Folders cannot be triggered via webhooks. You must trigger individual elements inside them.

Setup Instructions #

  1. Create an Image, Text, or Audio element in the Studio.
  2. Select the element. In the right-hand panel, toggle Allow Triggering via Webhook to ON.
  3. For visual elements, set the Display Duration (seconds) to control how long it appears.
  4. The Studio generates a ready-to-use curl command, copy it from the editor panel.
  5. Click Fire Webhook Now in the editor to test instantly. The Studio auto-publishes your current state before firing.

>_ Example cURL Command # 

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}'

Testing Webhooks #

Planet Icon (Layers Panel)

Elements in Webhook mode show a icon in the Layers panel. Click it to instantly fire a test trigger. The icon pulses blue while active. The Studio auto-publishes before firing.

Play Button (Audio Only)

Audio elements have a "Play" button in the editor for local preview, and a "Fire Webhook Now" button that triggers the actual API endpoint against your live overlay.

Automation Scenarios #

  • Elgato Stream Deck: Map a button to execute the provided curl script via a "System → Run" action to send the command to your overlay.
  • Chat Bot Integration: Have a Nightbot, Python, or Node.js bot call your webhook on commands like !airhorn.
  • Visuals + Audio Combo: Create separate Image and Audio elements, then fire both webhooks simultaneously from a Multi-Action or script for a combined audiovisual effect.
  • Other Services Integration: Use Zapier or Make.com to automatically trigger visual elements or sounds on your stream in response to events from other platforms.