Subscribers

This documentation site is deprecated. Please visit the control panel at https://monitorss.xyz for all up-to-date functionality

Subscribers are users or roles that are mentioned when a new article has arrived. Subscribers can also have filters attached to them so they're only mentioned when certain articles pass their respective filters. To add new subscribers, use the mention comand.

Regular users can add subscribed roles to themselves with the sub command. Regular users can also remove subscribed roles from themselves with the unsub command.

For the role mentions to show up on messages, the placeholder {subscriptions} must be used.

Format

Role Subscriber

Subscriber

{
    "feed": ObjectId("feedid"),
    "type": "role",
    "id": "<role id here>"

}

User Subscriber

Subscriber

{
    "feed": ObjectId("feedid"),
    "type": "user" ,
    "id": "<user id here>"
}

Filters

The same filter format as feed filters are used (both regular and regex).

Regular Filters

Subscriber

{
    "feed": ObjectId("feedid"),
    "type": "role" ,
    "id": "<role id here>",
    "filters": {
        "title": ["hello"]
    }
}

Regex Filters

Subscriber

{
    "feed": ObjectId("feedid"),
    "type": "role" ,
    "id": "<role id here>",
    "rfilters": {
        "title": "\d+"
    }
}