Create a monitor

Header Parameters

Kausate-Version?string

Default"2026-05-01"

Formatdate

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

kausateId*string

Kausate ID of the company to monitor

sources*array<>

Monitoring source names (e.g. 'de_handelsregister.company_report'). Discover available sources via GET /v2/events/sources.

Items1 <= items

categoriesFilter?array<>|

Restrict deliveries to these categories. Omit to receive all categories. Independent of eventCodesFilter — both filters apply if both are set.

eventCodesFilter?array<>|

Restrict deliveries to these event codes. Optional.

autoDeactivateCategories?array<>|

Categories whose events flip is_active=false. Defaults to ['disappeared']. Pass [] to opt out.

scheduleCron*string

Cron expression for per-company sources. Ignored for global feed sources.

webhookUrl?|

If set, change events are POSTed to this URL.

metadata?|

Arbitrary JSON object stored on the monitor and echoed back under the metadata key: verbatim on monitor read responses, and merged into each change event's / webhook's metadata (alongside Kausate's own event annotations, which win on any key collision). Use it to correlate change events with your own records, e.g. an internal case ID. Must be a JSON object no larger than 4 KB when serialized.

Response Body

`application/json`

curl -X POST "https://api.kausate.com/v2/monitors" \  -H "Kausate-Version: 2026-05-01" \  -H "Content-Type: application/json" \  -d '{    "kausateId": "string",    "sources": [      "string"    ],    "scheduleCron": "string"  }'

{
  "monitorId": "075fef10-8522-4c43-ac39-f1796133943e",
  "kausateId": "string",
  "companyName": "string",
  "sources": [
    "string"
  ],
  "categoriesFilter": [
    "string"
  ],
  "eventCodesFilter": [
    "string"
  ],
  "autoDeactivateCategories": [
    "string"
  ],
  "scheduleCron": "string",
  "webhookUrl": "string",
  "metadata": {},
  "isActive": true,
  "deactivationReason": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "apiUrl": "string"
}

Empty

Authorization

Header Parameters

Request Body

Response Body

201application/json

401

403

404

422

`application/json`