Close menu
Explore Plans
Mobile menu Close menu
Stoat

New message with a phrase

This trigger fires every time a new message containing a specific phrase is posted in the channel you specify.

Developer info

API endpoint slug
stoat.new_message_with_phrase

Trigger fields

Channel link Text input

Label
Channel link
Helper text
Right-click a channel in the Stoat app and choose Copy Link, then paste it here (e.g. https://stoat.chat/server/.../channel/...). Invite your bot to the server first.
Slug
channel_link
Required
true
Can have default value
true

Phrase Text input

Label
Which phrase or keyword?
Helper text
We'll fire when a message contains this text (not case-sensitive).
Slug
phrase
Required
true
Can have default value
true

Ingredients

Message The unique identifier of the message.

Slug
message_id
Filter code
Stoat.newMessageWithPhrase.MessageId
Type
String
Example
01HQZ8K3T7M9N2P4R6S8V0W1X2

Text The text content of the message.

Slug
text
Filter code
Stoat.newMessageWithPhrase.Text
Type
String
Example
We have an incident in production.

Matched phrase The phrase that matched the message.

Slug
matched_phrase
Filter code
Stoat.newMessageWithPhrase.MatchedPhrase
Type
String
Example
incident

Author The unique identifier of the user who posted the message.

Slug
author_id
Filter code
Stoat.newMessageWithPhrase.AuthorId
Type
String
Example
01F8MECHZX3TBDK0WJQ7FJ8R5T

Author name The username of the user who posted the message.

Slug
author_name
Filter code
Stoat.newMessageWithPhrase.AuthorName
Type
String
Example
jane

Channel The unique identifier of the channel the message was posted in.

Slug
channel_id
Filter code
Stoat.newMessageWithPhrase.ChannelId
Type
String
Example
01F7ZSBSFHQAAVCFQTFJWXR5SE

Server The unique identifier of the server the message was posted in.

Slug
server_id
Filter code
Stoat.newMessageWithPhrase.ServerId
Type
String
Example
01F7ZSBSFHQAAVCFQTFJWXR5SF

Created at The date and time the message was posted.

Slug
created_at
Filter code
Stoat.newMessageWithPhrase.CreatedAt
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06+05:00

Link to message A direct link to the message in the Stoat web client.

Slug
link_to_message
Filter code
Stoat.newMessageWithPhrase.LinkToMessage
Type
Web URL
Example
https://stoat.chat/server/01F7ZSBSFHQAAVCFQTFJWXR5SF/channel/01F7ZSBSFHQAAVCFQTFJWXR5SE/01HQZ8K3T7M9N2P4R6S8V0W1X2