Create Monitor

POST /v1/monitors

10 credits / 24h Permission: monitors:write

Creates a new keyword monitor across Reddit posts and/or comments. Billed 10 credits upfront for the first 24 hours. Daily match volume and webhooks are free.

Authorization

bearerAuth: optional HTTP

apiKeyAuth: optional API key in header

Request body JSON required

name: required string
keywords: required array ofstring
exclude: optional array ofstring
subreddits: optional array ofstring
posts: optional boolean

default: true
comments: optional boolean

default: true
nsfw: optional boolean

default: false
webhook_url: optional string
webhook_kind: optional generic|slack|discord|telegram

Returns

201

Created monitor and HMAC secret

JSON

monitor: optional object
- id: required string
- name: required string
- keywords: required array ofstring
- include_posts: required boolean
- include_comments: required boolean
- nsfw: required boolean
- status: required active|paused|paused_balance|deleted
- next_charge_at: required string
  
  format: date-time
- created_at: required string
  
  format: date-time
- updated_at: required string
  
  format: date-time
- exclude: optional array ofstring
- subreddits: optional array ofstring
- webhook_url: optional string | null
- webhook_kind: optional generic|slack|discord|telegram|null
- webhook_failing: optional boolean
- last_match_at: optional string | null
  
  format: date-time
webhook_secret: optional string

400

Bad request (invalid parameter or unknown action)

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

401

Missing or invalid API key or OAuth access token

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

402

The account has no credits left (insufficient_credits).

JSON

error: required object
- code: required string
- message: required string
- retryable: required boolean
- retry_after: optional integer
  
  Seconds to wait before retrying.

429

Rate limit or daily request quota exceeded

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.