Watch a company
watch_companySubscribe to a company's hiring events on a registered webhook --
webhook_endpoint_id must belong to the same customer as the
authenticated key. Meters one watch unit.
`event_types` names which events fire it, at least one of: `opened` (a
req seen for the first time), `reobserved` (a known req seen again on a
later day), `reposted` (a req that came back after it was gone), `closed`
(a req verified gone from its source). Anything else is refused and
creates nothing: a watch on a type that never fires would be billed and
silent.
A free key holds a limited number of watches at once; the one past that
is refused with the same 402 the REST route raises, and cancelling a
watch returns the slot.Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | ||
| event_types | Yes | ||
| plane_api_key | No | Deprecated: pass the key in the `X-API-Key` header. Removed in 1.2. | |
| idempotency_key | No | ||
| webhook_endpoint_id | Yes |