Watch a company or a saved search
Subscribe to hiring events on a registered webhook -- scoped to the caller's own customer: webhook_endpoint_id must belong to the same customer. Meters one watch unit.
The watch covers one company (company_id) or a saved search (criteria) -- exactly one, and a criteria outside the closed vocabulary is a 422 raised before any row is written. So is an event_types that is empty or names anything but opened, reobserved, reposted or closed: such a watch could never fire, so it is refused rather than created and metered.
A free key holds a limited number of watches AT ONCE; the one past that is a 402 carrying the upgrade path, checked before the watch is created, so a walled call leaves no subscription behind. Cancelling a watch returns the slot.
Requires the webhooks scope.
Request
- Base URL: https://api.reqbeat.com
- URL: https://api.reqbeat.com/v1/watches
- Auth: one of:
- API key in header X-API-Key
- HTTP bearer
Headers
Request body
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.