Webhooks

VisionAlert also supports webhooks. It allows you to receive an HTTP POST request to a target URL of your choosing.

To manage your webhooks or add a new webhook target, head to the license configuration page, where you'll find the options just below the cameras section.

Webhooks

Note:

The Target URL should return a valid HTTP status code 200. If the Target URL consistently returns an error code, the hook will be removed and an email will be sent to the account owner.
To quickly test out this feature, you can use webhook.site. It generates a unique target URL and displays all the requests made to that URL.

Payload

The payload is the JSON object that is sent to the target URL. It contains information about the alert.

Here is an example of the payload:

{
  "license": "XXXXXXXXXX",
  "user": "user@example.com",
  "anomaly": "Offline",
  "cameras": [
    {
      "serial": "d3905c1c-1f78-dea5-26e8-b4917e5e282b",
      "name": "Cam-01",
      "anomaly": "Offline",
      "tags": ["Tag XXX"],
      "reference_image": null,
      "latest_image": null
    }
  ]
}

The payload contains the following fields:

license: License linked to integration.
user: Email address of the main Plate Recognizer account.
camera: Information about the camera that triggered the alert.
- name: The name of the camera.
- tags: The tags assigned to the camera.
- anomaly: Information about the alert.

Payload​

Payload