Monitors

Create a monitor

Create a monitor that polls a watchable source on a schedule.

post/v1/monitors

Request

  • Base URL: https://api.socialfetch.dev
  • URL: https://api.socialfetch.dev/v1/monitors
  • Auth: one of:
    • API key in header x-api-key
    • none

Query parameters

dryRunboolean

When true, validates the monitor and returns a cost preview without creating anything or running the baseline check.

Request body

namestring

Optional display name for the monitor. A default is generated from the source and params when omitted.

operationIdstring required

Watchable public API operation id to poll. See GET /v1/monitors/sources.

paramsobject required

Parameters for the watched operation.

webhookEndpointIdstring

Existing webhook endpoint id (owned by this account) to deliver events to. Mutually exclusive with webhook.

spendCapCreditsinteger

Optional monthly credit spend cap for this monitor.

Response

The newly created monitor.

Changes

No recorded changes to this operation across all 1 revision of this API.