WebHooks API

WebHooks can be used to retrieve real time notifications generated by the LiveReach AI NVR. WebHooks will be POSTed to the specified URL. If the URL does not return a 2xx status code, the webhook will retried up to 3 times with an exponential delay.

The Webhook object

Attributes

idstringOptional

urlstring · uriRequired

camera_idsstring[]Optional

Filter for events that are relevent to the specified camera IDs. An empty array means no filtering will occur.

server_idsstring[]Optional

Filter for events that are relevent to the specified server IDs. An empty array means no filtering will occur.

location_idsinteger[]Optional

Filter for events that are relevent to the specified location IDs. An empty array means no filtering will occur.

eventsstring[]Optional

Filter for the following event kinds. An empty array means no filtering will occur.

The Webhook object

{
  "id": "text",
  "url": "https://example.com",
  "camera_ids": [
    "text"
  ],
  "server_ids": [
    "text"
  ],
  "location_ids": [
    1
  ],
  "events": [
    "text"
  ]
}