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

Subscription

Fires on a new subscription or resub.

trigger.subscribe · 2.8.0

Browse all entries

Requirements and availability

Connected supported event provider; enabled automation and matching filters.

Picker contexts: automation.

Incoming providers: twitch, youtube, kick, tiktok.

Behavior

Subscription months/count must meet both minimums. Missing event months/count are treated as 1. A nonblank TikTok type filter matches subscriptionKind exactly, including gifted subscriptions.

Configure in the app

Open: Bot → Automations → + New → When

Steps

Choose Trigger category: Monetization.
Choose Trigger event: Subscription.
Fill the Trigger filters below, set Cooldown (seconds), then open Where and choose a supported Platform.
Open Do, add actions, then Create Automation or Save Changes.

Trigger filters

Field Input / options Defaults / limits Availability

Field	Input / options	Defaults / limits	Availability
Minimum months (0 = any) `min_months`	number	Declared UI default: `0` Min: 0	Trigger filter
Minimum count (0 = any) `min_count`	number	Declared UI default: `0` Min: 0	Trigger filter
TikTok subscription type `subscription_kind`	select Any type: (blank) New subscription: subscribe Resubscription: resubscribe Gifted subscription: subscription_gift Super Fan: super_fan		Trigger filter

Minimum months (0 = any)
min_months

number

Declared UI default: 0

Min: 0

Trigger filter

Minimum count (0 = any)
min_count

number

Declared UI default: 0

Min: 0

Trigger filter

TikTok subscription type
subscription_kind

select

Any type: (blank)
New subscription: subscribe
Resubscription: resubscribe
Gifted subscription: subscription_gift
Super Fan: super_fan

Trigger filter

Contract details

Cooldown: Automation cooldownSec defaults 0; keyed by automation ID and event platform; held in memory until restart.
Delay: No additional trigger delay.

Examples

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

{
  "triggerType": "subscribe",
  "triggerPlatform": "twitch",
  "triggerFilters": {
    "min_months": 0,
    "min_count": 0,
    "subscription_kind": ""
  }
}

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.subscribe
src/features/automation-provider-capabilities.js — AUTOMATION_TRIGGER_PLATFORMS.subscribe

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1