Skip to main content
POST
TypeScript
Start watching the web for new pages about a topic. Store webhook.secret from the response. Only this response and an update that adds a first webhook carry it. Send an Idempotency-Key header so a retried create doesn’t make a second monitor. See Monitors for schedules, events and signatures.

When to use it

Create one monitor per topic. Every key in your organization sees the same monitors, so first list your monitors with name and reuse one on the same topic. Write search.query as a topic in plain words, not keywords. Write a good query has examples. A new monitor starts empty and doesn’t backfill: it matches only pages crawled after you create it. For pages already published, use Search. A create counts toward your organization’s active monitors. See Limits. The same Idempotency-Key with the same body within 24 hours returns the monitor the first call created. The same key with another body returns 409 with idempotency_conflict.

SDK, CLI and MCP

The SDK methods need SDK 0.2.0 or later. Each SDK sends an Idempotency-Key on every create, yours or a new one, so it can retry the call safely. See SDKs → Monitors, CLI → Monitors and Monitors tools. For a step-by-step guide, see Create a monitor.

Authorizations

X-API-Key
string
header
required

Your API key, such as keen_.... Create one in the Keenable console. If you send both this header and Authorization, the API uses this one.

Headers

Idempotency-Key
string

Any string. Within 24 hours, the same key with the same body returns the monitor the first call created instead of creating another one.

Body

application/json

What to watch for. A field other than these returns 400 with monitor_option_not_supported.

name
string | null

A display name. Defaults to the query.

Maximum string length: 200
Example:

"Open-weights LLM releases"

schedule
object | null

When runs happen. Without a schedule, runs happen only when you trigger one.

webhook
object | null
output_schema
object | null

A JSON Schema. With it, each run that finds pages also returns output: a summary of those pages in this shape, with the pages that support each field.

metadata
object | null

Your own string tags, at most 50 keys. Every webhook event carries them. For example {"team": "research"}.

Response

The new monitor, with webhook.secret when you sent a webhook

id
string
required
Example:

"mon_3kq9z2c8f1a04b7d9e6f5a21"

object
enum<string>
required
Available options:
monitor
name
string | null
required
Example:

"Open-weights LLM releases"

status
enum<string>
required

active and paused are set by you. completed: a once monitor after its run. disabled: set by Keenable after 10 failed runs in a row, or when no webhook delivery succeeded for 3 days. Only an active monitor matches pages.

Available options:
active,
paused,
disabled,
completed
schedule
object | null
required

All three keys are always present. timezone is UTC for a cron schedule sent without one, and null for interval and once.

webhook
object | null
required
metadata
object | null
required
last_run_at
string<date-time> | null
required

When the last run ended.

next_run_at
string<date-time> | null
required

The next scheduled run. null without a schedule or while the monitor isn't active.

upcoming_runs
string<date-time>[]
required

The next three run times, in UTC. Empty without a schedule or while the monitor isn't active.

created_at
string<date-time>
required
updated_at
string<date-time>
required
output_schema
object | null