Monitors

Create a monitor

Re-runs a list-returning Captapi GET endpoint on your interval and POSTs only new items to your webhook. endpoint must be a Captapi GET path; webhook_url must be an external https URL. interval_minutes is 15-1440 (default 60), at most 20 monitors per account. Each delivery is signed: X-Captapi-Signature is sha256=HMAC-SHA256(secret, "{X-Captapi-Timestamp}.{raw body}"). The secret is generated when omitted and returned here. Managing monitors is free; each scheduled run is billed like calling the endpoint directly.

post/v1/monitors

Request

  • Base URL: https://api.captapi.com
  • URL: https://api.captapi.com/v1/monitors
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

namestring
endpointstring required

Captapi GET path, e.g. /v1/reddit/subreddit-posts

paramsobject
interval_minutesinteger
webhook_urlstring required

HTTPS URL that receives new-item payloads

secretstring nullable

HMAC secret; generated if omitted

Response

Success.

successunknown required

Changes

No recorded changes to this operation across all 3 revisions of this API.