Skip to main content
POST
Create Monitor

Authorizations

Authorization
string
header
required

Signalbase API key. Include as a Bearer token in the Authorization header.

Body

application/json
name
string
required

Display name, e.g. "Key accounts".

Required string length: 1 - 255
signal_types
enum<string>[]
required

Signal types to deliver. At least one.

Minimum array length: 1

A signal type a monitor can listen for. funding_round = the company raised a round; acquisition = the company acquired or was acquired; job_change = someone joined or left the company; hiring = the company posted a new job.

Available options:
funding_round,
acquisition,
job_change,
hiring
webhook_url
string<uri>

Publicly reachable endpoint to receive this monitor's signals. Private, loopback, and link-local addresses are rejected. Omit for an email-only monitor.

Maximum string length: 500

Response

Monitor created. data.webhook.secret is present only when webhook_url was provided, and only in this response.

success
boolean
required
data
object
required
meta
object
required