> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blazemonitors.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Role Pingers

> Ping roles when specific keywords appear in messages

### Role Pingers Guide

Role pingers allow you to automatically ping specific roles when messages containing certain keywords appear in designated channels. This is useful for alerting groups about specific products, events, or topics they're interested in.

**How It Works**

```mermaid theme={null}
flowchart LR
S1\[Channel 1] -->|Keywords Match| P\[Pinger]
S2\[Channel 2] -->|Keywords Match| P
S3\[Channel 3] -->|Keywords Match| P
P -->|Pings Role| S1
P -->|Pings Role| S2
P -->|Pings Role| S3
```

**Basic Example**

<Steps>
  <Step title="Step 1">
    Create a Pinger

    *Here, you can create the pinger and choose the role to ping in specific channels.*

    ```
    /pingers create role:@pokemon-drops channels:#target #walmart
    ```
  </Step>

  <Step title="Step 2">
    Add Keywords

    *Add keywords that will trigger the role ping. You can add multiple positive and negative keywords. We use the `OR` logic so each keyword will act independently.*

    ```
    /pingers add-keywords id:pokemon~123 keywords:+charizard, -pikachu
    ```
  </Step>
</Steps>

**Keyword Guide**

* Use `+` prefix for positive keywords (optional)

* Use `-` prefix for negative keywords

* Separate keywords with `,`

<Tip>
  You may use the `*` wildcard to ping for all messages instead of using positive keywords. However, any configured negative keywords will still apply
</Tip>

### Commands

**List All Pingers**

```
/pingers list
```

**View Pinger Config**

```
/pingers config id:pokemon~~123
```

**Add Channels**

```
/pingers add-channels id:pokemon~~123 channels:#target #bestbuy
```

**Remove Channels**

```
/pingers rm-channels id:pokemon~~123 channels:#target
```

**Add Keywords**

```
/pingers add-keywords id:pokemon~~123 keywords:+pikachu, +cards, -fake
```

**Remove Keywords**

```
/pingers rm-keywords id:pokemon~~123 keywords:+pikachu
```

**Set Pinger Cooldown**

```
/pingers set-cooldown id:pokemon~~123 positive-keyword:pikachu channel: #target cooldown:5
```

**Delete Pinger**

```
/pingers delete id:pokemon~~123
```