Skip to reference

Beta reference. Prepared from development builds for this version. This reference does not describe the current stable release.

A verified stable reference is not available yet. Choose a prepared beta version above.

When · Triggers · supported

Ad break

Fires when an ad break starts, with an optional time offset.

trigger.ad_break · 2.8.0

Browse all entries

Requirements and availability

Connected supported event provider; enabled automation and matching filters.

Picker contexts: automation.

Incoming providers: twitch.

Behavior

Match ad-start with optional automatic/manual filter. Positive offset delays actions; negative offsets clamp to immediate and do not schedule a pre-ad action.

Configure in the app

Open: Bot → Automations → + New → When

Steps

  1. Choose Trigger category: Platform events.
  2. Choose the incoming Platform first.
  3. Choose Trigger event: Ad break.
  4. Fill the Trigger filters below, set Cooldown (seconds), then open Where and choose a supported Platform.
  5. Open Do, add actions, then Create Automation or Save Changes.

Trigger filters

FieldInput / optionsDefaults / limitsAvailability
Offset (seconds, negative = before if supported)
offset_sec
number

Declared UI default: 0

Min: -300

Max: 300

Trigger filter
Ad type
is_automatic
select
  • Any: (blank)
  • Automatic only: true
  • Manual only: false
Trigger filter

Contract details

Cooldown
Automation cooldownSec defaults 0; keyed by automation ID and event platform; held in memory until restart.
Delay
offset_sec positive delays; negative clamps to 0.

Examples

Trigger selection and filter defaults; supply a real target/pattern when required.

{
  "triggerType": "ad_break",
  "triggerPlatform": "twitch",
  "triggerFilters": {
    "offset_sec": 0,
    "is_automatic": ""
  }
}

Related entries

Source and verification

Source-reviewed for 2.8.0. Connected-service validation remains subject to release UAT.

  • src/features/automations.js — TRIGGER_REGISTRY.ad_break
  • src/features/automation-provider-capabilities.js — AUTOMATION_TRIGGER_PLATFORMS.ad_break

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1

Downloads and AI prompt
Download JSONDownload Markdown