Skip to main content
POST
companies.signals.monitor.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
domain
string
required

The company website domain to watch, e.g. figma.com.

name
string

A label for the watch.

Required string length: 1 - 100
schedule
string

Five-field UTC cron expression for the checks. Only schedules the source serves exactly are accepted: daily at a fixed hour ("0 9 * * *", the default), hourly or every 2, 3, 4, 6, 8 or 12 hours, every N days, weekly on a weekday, or monthly on days 1-28. Default: daily at 09:00 UTC.

Maximum string length: 120

Response

The result

domain
string
required

The watched company's website domain.

schedule
string
required

Five-field cron expression, UTC, the checks run on.

name
string

The watch's label.

status
enum<string>

Current state of the watch.

Available options:
active,
paused,
error
createdAt
string

When the watch was created, ISO 8601.

lastRunAt
string

When the watch last ran, ISO 8601.

nextRunAt
string

When the watch runs next, ISO 8601.

ref
string

Reference to what this call created. Pass it as ref to companies.signals.monitor.list, update, run, delete, events.