Action Templating

Actions that can submit text (Report, Comment, UserNote, Message, Ban, Submission) will have their content values run through a Mustache Template. This means you can insert data generated by Rules into your text before the Action is performed.

See here for a cheatsheet and here for a more thorough tutorial.

Template Data

Some data can always be accessed at the top-level. Example

This action was run from  in Check .

The bot intro post is 

Message the moderators of this subreddit using this [compose link]()

Activity Data

Activity data can be accessed using the item variable. Example

This activity is a  with  votes, created  ago.

Produces:

This activity is a submission with 10 votes created 5 minutes ago.

Common

All Actions with content have access to this data:

Common Author

Additionally, author has these properties accessible:

NOTE: Accessing these properties may require an additional API call so use sparingly on high-volume comments

Example Usage

The user  has been a redditor for 

Produces:

The user FoxxMD has been a redditor for 3 months

Submissions

If the Activity is a Submission these additional properties are accessible:

Comments

If the Activity is a Comment these additional properties are accessible:

Moderator

If the Activity occurred in a Subreddit the Bot moderates these properties are accessible:

Rule Data

Summary

A summary of what rules were processed and which were triggered, with results, is available using the ruleSummary variable. Example:

A summary of rules processed for this activity:

Would produce:

A summary of rules processed for this activity:

• namedRegexRule - ✘
• nameAttributionRule - ✓ - 1 Attribution(s) met the threshold of < 20%, with 1 (3%) of 32 Total – window: 6 months
• noXPost ✓ - ✓ 1 of 1 unique items repeated <= 3 times, largest repeat: 1

Individual

Individual Rules can be accessed using the name of the rule, lower-cased, with all spaces/dashes/underscores. Example:

Submission was repeated  times

Produces

Submission was repeated 7 times

Action Data

Summary

A summary of what actions have already been run when the template is rendered is available using the actionSummary variable. It is therefore important that the Action you want to produce the summary is run after any other Actions you want to get a summary for.

Example:

A summary of actions processed for this activity, so far:

Would produce:

A summary of actions processed for this activity, so far:

• approve - ✘ - Item is already approved??
• lock - ✓
• modnote - ✓ - (SOLID_CONTRIBUTOR) User is good

Individual

Individual Actions can be accessed using the name of the action, lower-cased, with all spaces/dashes/underscores. Example:

User was banned for  for 

Produces

User was banned for 4 days for toxic behavior

Quick Templating Tutorial

As a quick example for how you will most likely be using templating – wrapping a variable in curly brackets, ``, will cause the variable value to be rendered instead of the brackets:

myVariable = 50;
myOtherVariable = "a text fragment"
template = "This is my template, the variable is , my other variable is , and that's it!";

console.log(Mustache.render(template, {myVariable});
// will render...
"This is my template, the variable is 50, my other variable is a text fragment, and that's it!";

Note: When accessing an object or its properties you must use dot notation

const item = {
    aProperty: 'something',
    anotherObject: {
        bProperty: 'something else'
    }
}
const content = "My content will render the property  like this, and another nested property  like this."