Root definitions

Root

object

Permalink

Properties

caching

CacheConfig

checks

Array<anyOf [IncludesData, SubmissionCheckConfigData, CommentCheckConfigData, string]>

A list of all the checks that should be run for a subreddit.

Checks are split into two lists -- submission or comment -- based on kind and run independently.

Checks in each list are run in the order found in the configuration.

When a check "passes", and actions are performed, then all subsequent checks are skipped.

Min items: 1
credentials

ThirdPartyCredentialsJsonConfig

databaseStatistics

DatabaseStatisticsJsonConfig

dryRun

boolean

Use this option to override the dryRun setting for all Checks

Default: undefined
filterCriteriaDefaults

FilterCriteriaDefaultsJson

footer

anyOf [boolean, string]

Customize the footer for Actions that send replies (Comment/Ban). This sets the default value for all Actions without footer specified in their configuration.

If false no footer is appended

If string the value is rendered as markdown or will use wiki: parser the same way content properties on Actions are rendered with templating.

If footer is undefined (not set) the default footer will be used:


This action was performed by [a bot.] Mention a moderator or [send a modmail] if you any ideas, questions, or concerns about this action.


The following properties are available for templating:

Copy
1 2 3 4 subName => name of subreddit Action was performed in (EX 'mealtimevideos') permaLink => The permalink for the Activity the Action was performed on EX https://reddit.com/r/yourSub/comments/o1h0i0/title_name/1v3b7x modmaiLink => An encoded URL that will open a new message to your subreddit with the Action permalink appended to the body botLink => A permalink to the FAQ for this bot.

If you use your own footer or no footer please link back to the bot FAQ using the {{botLink}} property in your content :)

Default: undefined
nickname

string

notifications

NotificationConfig

polling

Array<anyOf [PollingOptions, string]>

An array of sources to process Activities from

Values in the array may be either:

A string representing the pollOn value to use

One of:

  • unmoderated
  • modqueue
  • newSub
  • newComm

with the rest of the PollingOptions properties as defaults

A PollingOptions object

If you want to specify non-default properties


If not specified the default is ["unmoderated"]

postCheckBehaviorDefaults

PostBehavior

queue

queue

retention

anyOf [DurationObject, string ∪ number]

Number of Events, or time range of events were processed during, that should continue to be stored in the database. Any Events falling outside this criteria will be deleted Leave unspecified to disable deleting anything

runs

Array<anyOf [IncludesData, RunConfigData, string]>

A list of sets of Checks to run

Min items: 1
sharing

anyOf [Array<string>, SharingACLConfig, boolean]

Enables config sharing

  • (Default) When false sharing is not enabled
  • When true any bot that can access this bot's config wiki page can use inpm t
  • When an object, use include or exclude to define subreddits that can access this config
Loading...

Editor and Validator