Skip to main content
Create a saved-search monitor with optional webhook or email delivery destination
Audience: signed-in organization administrator.

Creation constraints

A monitor requires a non-empty name and query. Choose one destination model: the legacy webhookUrl field and delivery cannot be sent together. Email delivery and certain event subscriptions can require account activation; preserve Retry-After on a throttled response. startAt defines the initial search boundary for ordinary saved searches. Structured search modes are validated against their own filter schema and may be unavailable. Creating a monitor records configuration; it is not a guarantee of a polling interval, match volume, or successful downstream delivery.

Canonical metadata

  • requestId
  • traceparent

Example request

This organization control-plane action requires a signed-in WorkOS browser session. Do not give an API key or an autonomous agent authority to create, change, test, replay, rotate, or delete it.

Example response

Give this prompt to your agent

Failure posture

  • treat non-2xx responses as contract-aware failures, not free-form errors
  • preserve requestId and traceparent in logs and downstream reports
  • if provenance or freshness metadata is present, return it unchanged so trust is not lost in the handoff