Monitors

Create a monitor

Monitors a list of records and sends their events to one of your webhooks until the monitor expires. A job monitor sends job.closed when a job in it closes. The ids are looked up, so the response also says, for free, which are already closed and which match nothing; neither is added. Costs no credits.

post/v1/monitors

Request

  • Base URL: https://api.jobspipe.dev
  • URL: https://api.jobspipe.dev/v1/monitors
  • Auth: none declared

Request body

typestring required

What the ids are. "job" today.

idsstring[] required

Record ids as search returned them, up to 1000 per request.

eventsstring[]

Events to send. Default: every event of the type ("job.closed").

webhook_idstring uuid required

One of your webhooks, from /api/webhooks.

expires_in_daysnumber

How many days the monitor runs, a whole number from 1 to 365. Default 90.

Response

The monitor.

idstring required
typestring required
eventsstring[] required
webhook_idstring required
status'active' | 'expired' required
expires_atstring required
created_atstring required
target_countinteger required
open_target_countinteger required
not_foundstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.