Create a monitor
Starts watching a company. Register changes of the chosen event types are
delivered to your webhook endpoints (configured in the dashboard). A company can
have one monitor per account; creating a second returns 409 with the existing
monitor's id.
Costs 10 credits, once.
Authorization
bearerAuth Your API key, sent as Authorization: Bearer rc_live_….
In: header
Header Parameters
Makes a retry safe. A request repeated with the same key within 24 hours returns
the first response (with Idempotent-Replayed: true) instead of acting twice.
Reusing a key with a different body returns 422; retrying while the first
request is still running returns 409. Use a random UUID.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A new monitor.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/monitors" \ -H "Content-Type: application/json" \ -d '{ "company_id": "3f1c2a9e-5b7d-4c8a-9e21-6d4f0b8a1c55", "event_types": [ "*" ] }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "monitor", "company": { "object": "company", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "event_types": [ "*" ], "status": "active", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}