Skip to main content
Corvus Connection

On Keyword Match

Entry
Trigger
entry.onKeywordMatchFires when a chat message matches a keyword or regular expression. Binds the matched text and the sender.
ChatEngagement

Outputs

Name
Kind
Type
Flags
out
Exec
exec
None
match
Data
System.String
multiplexed
user
Data
System.String
multiplexed
message
Data
System.String
multiplexed
  • Name
    out
    Kind
    Exec
    Type
    exec
    Flags
    None
  • Name
    match
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    user
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    message
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed

Bindings

Name
Type
Description
match
System.String
The keyword or phrase that matched.
user
System.String
The chatter's display name.
message
System.String
The full chat message that contained the match.
  • Name
    match
    Type
    System.String
    Description
    The keyword or phrase that matched.
  • Name
    user
    Type
    System.String
    Description
    The chatter's display name.
  • Name
    message
    Type
    System.String
    Description
    The full chat message that contained the match.

Parameters

Name
Type
Required
Default
Choices
pattern
System.String
yes
""
None
matchMode
System.String
no
"keyword"
Keyword, Regular expression
minRole
System.String
no
"everyone"
Everyone, Subscriber+, VIP+, Moderator+, Broadcaster
cooldownSeconds
System.Int32
no
0
None
perUserCooldownSeconds
System.Int32
no
0
None
debounceMs
System.Int32
no
0
None
dedupeKey
System.String
no
""
None
maxConcurrency
System.Int32
no
0
None
  • Name
    pattern
    Type
    System.String
    Required
    yes
    Default
    ""
    Choices
    None
  • Name
    matchMode
    Type
    System.String
    Required
    no
    Default
    "keyword"
    Choices
    Keyword, Regular expression
  • Name
    minRole
    Type
    System.String
    Required
    no
    Default
    "everyone"
    Choices
    Everyone, Subscriber+, VIP+, Moderator+, Broadcaster
  • Name
    cooldownSeconds
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    perUserCooldownSeconds
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    debounceMs
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    dedupeKey
    Type
    System.String
    Required
    no
    Default
    ""
    Choices
    None
  • Name
    maxConcurrency
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None