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

Chat message contains / equals

Fires when a chat message matches a keyword, pattern, or exact phrase.

trigger.chat_contains · 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

Nonempty pattern required. Equals compares trimmed text case-insensitively. Contains treats ordinary text literally; /pattern/flags uses JavaScript regex, invalid regex never matches. The authority field is displayed but match() does not enforce it; do not rely on this filter as an access-control gate.

Configure in the app

Open: Bot → Automations → + New → When

Steps

  1. Choose Trigger category: Chat & viewers.
  2. Choose Trigger event: Chat message contains / equals.
  3. Fill the Trigger filters below, set Cooldown (seconds), then open Where and choose a supported Platform.
  4. Open Do, add actions, then Create Automation or Save Changes.

Limitations

  • Minimum authority is exposed in the editor but is not enforced by this matcher.

Trigger filters

FieldInput / optionsDefaults / limitsAvailability
Keyword or regex (wrap in /.../ for regex)
pattern
text

Example hint: hello|hi there

Trigger filter
Match mode
matchMode
select
  • Contains (default): contains
  • Equals (exact match): equals
Trigger filter
Minimum authority
authority
select
  • Anyone: anyone
  • Subscriber+: subscriber
  • Moderator+: moderator
  • Broadcaster only: broadcaster
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": "chat_contains",
  "triggerPlatform": "all",
  "triggerFilters": {
    "pattern": "",
    "matchMode": "contains",
    "authority": "anyone"
  }
}

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

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1

Downloads and AI prompt
Download JSONDownload Markdown