Skip to main content
POST
Add monitoring for a company

Authorizations

x-api-key
string
header
required

Body

application/json
companyId
string
required

The company ID to monitor

Example:

"123456789"

countryCode
enum<string>
required

The country code for the company

Available options:
AT,
BE,
BG,
CH,
CN,
CZ,
CY,
DE,
DK,
EE,
ES,
FI,
FR,
GB,
GG,
GR,
HK,
HR,
HU,
IE,
IS,
IT,
JE,
LI,
LU,
LV,
MC,
MT,
MU,
NL,
NO,
PL,
PT,
RO,
RU,
SE,
SG,
SI,
SK,
VG
Example:

"DE"

metadata
object

Arbitrary key-value string pairs to associate with the monitor, echoed back in monitor responses and in every monitor.notification webhook. Use it to map notifications back to your internal records (e.g. a case ID). Calling POST /v2/monitors again for the same company replaces the stored metadata when the field is provided. Limits: max 50 keys, keys up to 40 chars (longer keys are skipped), values up to 500 chars (longer values are truncated).

Example:

Response

Monitor created or retrieved

id
string
required

The unique identifier for the monitor

Example:

"cmfzlu1dt000j12ldeqrfszq0"

companyId
string
required

The company ID being monitored

Example:

"123456789"

countryCode
string
required

The country code for the monitored company

Example:

"DE"

metadata
object

Key-value pairs provided at monitor creation, echoed back in responses and monitor.notification webhooks.

Example: