Create a monitor
Create a monitor that polls a watchable source on a schedule.
Headers
Get your API keyAPI key (`sfk_...`)
When true, validates the monitor and returns a cost preview without creating anything or running the baseline check.
Request body
Endpoint-specific response payload.
Stable identifier for the monitor.
min 1 chars
Display name for the monitor.
Watchable public API operation this monitor polls.
Canonicalized parameters used for each poll.
Polling schedule for a monitor: a fixed interval or a cron expression.
ISO-8601 timestamp for the monitor's next scheduled poll.
Estimated credit cost preview for this monitor's schedule.
Credits charged per poll.
≥ 0
Estimated credits charged per day at this schedule.
≥ 0
Estimated credits charged per 30-day month at this schedule.
≥ 0
Result of the synchronous baseline check run at creation time. Omitted for dry runs.
Outcome of the synchronous baseline check.
Preview of items observed by the baseline check.
Webhook endpoint created inline for this monitor, when `webhook.url` was given.
Newly created webhook endpoint id.
One-time signing secret for the new webhook endpoint. Shown only in this response — store it now.
Metadata describing the request and billing outcome.
Unique request identifier for tracing this API call.
min 1 chars
Credits charged for this request.
≥ 0
Public API version that served the response.
one of: v1
True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.
Code example
curl "https://api.socialfetch.dev/v1/monitors" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"string","operationId":"string","params":{},"schedule":null,"webhookEndpointId":"string","webhook":{"url":"string"},"spendCapCredits":0}' \
-X POSTResponses
The newly created monitor.