Create a monitor
POST
/v1/monitorsMCP
reddit_monitor1 credit per checkPlannedPlanned. Not callable yet.
Updated
Description
Create a monitor that checks Reddit for new posts and comments matching your terms and sends matches to a webhook. Not available yet. Costs 1 credit per check. Tip: until it ships, poll reddit.search with sort=new.
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
platform | body | enum | no | reddit | Where to watch. One of: reddit, x, everywhere. |
terms | body | string or array | yes | Words or phrases to watch for. | |
exclude | body | string or array | no | Words that disqualify a match. | |
kinds | body | array | no | post,comment | Item types to match. |
subreddit | body | string | no | Limit Reddit matches to one subreddit. | |
webhookUrl | body | string | no | URL that receives matches as they arrive. |
- platform body, enum
- Where to watch. One of:
reddit,x,everywhere. Defaultreddit. - terms body, string or array, required
- Words or phrases to watch for.
- exclude body, string or array
- Words that disqualify a match.
- kinds body, array
- Item types to match. Default
post,comment. - subreddit body, string
- Limit Reddit matches to one subreddit.
- webhookUrl body, string
- URL that receives matches as they arrive.
Request examples
curl -X POST "https://api.chatterapi.com/v1/monitors" \
-H "Authorization: Bearer $CHATTERAPI_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{}'Fill in the required parameters from the table above.
Response
data is one Monitor. Fields:
| Field | Type | Nullable | Description |
|---|---|---|---|
id | string | no | Platform id. |
platform | enum | no | reddit or x. |
terms | string[] | no | |
exclude | string[] | no | |
kinds | enum[] | no | |
subreddit | string | yes | Subreddit name without r/. |
webhookUrl | string | yes | |
status | enum | no | |
createdAt | string | no | ISO 8601 UTC timestamp. |
response
{
"data": null,
"credits": {
"charged": 1,
"remaining": 24997
},
"requestId": "req_01JA7Q3V8K2N4P5R6S7T8V",
"cached": false
}No recorded example yet.
Credits
1 credit per call (per check). Failed calls cost 0. Cached responses cost the same. Test keys cost 0.
Errors this endpoint can return
Try it
Not callable yet.