Monitor API
Create a monitor
Create an active Search or Page monitor.
POST
Use exactly one Search target, or 1 to 10 Page targets with distinct URLs. Do not mix Search and Page targets in one monitor. The monitor starts as
active; its first run becomes due immediately and starts asynchronously.
goal is optional and separate from the Search query. To retrieve results without notifications, omit webhook or set it to null; runs and their changes remain available through the API.
Webhook secrets and retries
When you configure a webhook without asecret, the service generates one and returns it in webhook.secret only in the response that generated it. Store it to verify deliveries. A secret you supply is never returned.
Use an Idempotency-Key header when retrying the original create request. Reusing the key returns the original monitor in its current state, even after an update, without its secret. Using the same key for a different create request returns 400. If the first response was lost, set a new secret with Update a monitor.
Creating a monitor at your API organization’s active-monitor cap returns HTTP 409 with quota_exceeded. Pause or delete an active monitor, or upgrade the organization’s tier, before retrying.
Authorizations
Headers
Body
application/json
Response
The created monitor, with webhook.secret if the service generated it
Fields that do not apply are omitted, never null: webhook,
pause_reason, current_run_id, next_run_at and last_run.