Skip to content

Create a monitor

POST/v1/monitors
MCPreddit_monitor1 credit per checkPlanned

Planned. 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

platform body, enum
Where to watch. One of: reddit, x, everywhere. Default reddit.
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:

FieldTypeNullableDescription
idstringnoPlatform id.
platformenumnoreddit or x.
termsstring[]no
excludestring[]no
kindsenum[]no
subredditstringyesSubreddit name without r/.
webhookUrlstringyes
statusenumno
createdAtstringnoISO 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.

More in Leads and monitoring