# Subscribers

{% hint style="warning" %}
**This documentation site is deprecated. Please visit the control panel at** [**https://monitorss.xyz** ](https://monitorss.xyz)**for all up-to-date functionality**
{% endhint %}

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.

{% hint style="warning" %}
For the role mentions to show up on messages, the placeholder `{subscriptions}` must be used.
{% endhint %}

## Format

{% tabs %}
{% tab title="Role Subscriber" %}
{% code title="Subscriber" %}

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

}
```

{% endcode %}
{% endtab %}

{% tab title="User Subscriber" %}
{% code title="Subscriber" %}

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

{% endcode %}
{% endtab %}
{% endtabs %}

### Filters

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

{% tabs %}
{% tab title="Regular Filters" %}
{% code title="Subscriber" %}

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

{% endcode %}
{% endtab %}

{% tab title="Regex Filters" %}
{% code title="Subscriber" %}

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

{% endcode %}
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.monitorss.xyz/bot-customizations/subscribers.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
