monitor

Create a monitor

Creates a monitor that watches a list.

Permits and cases filed on the list's places become permit.created and case.created events within a day of being published. Each is listed by GET /v1/event and sent to every webhook subscribed to its type. A place added to the list later is watched from when it is added. An item's filter applies to the parcels each permit or case is about. A list that already has a monitor returns it with 200.

post/v1/monitor

Request

  • Base URL: http://localhost:3030
  • URL: http://localhost:3030/v1/monitor
  • Auth: HTTP bearer

Request body

liststring required

The id of the list to watch.

activeboolean

Whether the monitor produces events. Defaults to true.

event_typestring[]

The event types to report. Defaults to all of them.

email_recipientstring[] nullable

Email addresses of members to send a daily summary to. Defaults to the caller's own address when a person creates the monitor, and to none for an API key.

Example request

{
  "list": "lst_01h455vb4pex5vsknk084sn02q"
}

Response

The list's existing monitor, unchanged.

Changes

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