Notify when a VFD event occurs

wbhk

onVFDEventTriggered

This webhook is triggered whenever a Visible Firearm Detection (VFD) event occurs. It sends event details to the specified endpoint. If a video clip is not available within 8 seconds of the event occurring, the payload will be sent without the video.

Payload

uuid

required

The unique identifier for the event.

eventTypeId

string

required

The type of event that occurred.

viewId

uuid

required

The unique identifier for the camera associated with the event.

siteId

uuid

required

The unique identifier for the site associated with the event.

companyId

uuid

required

The unique identifier for the company associated with the event.

aiResult

object

Details of the AI analysis for the event.

result

string

enum

required

The result of the event analysis.

Allowed:

reason

string | null

The reason for the result, if applicable.

reviewed

boolean

Indicates whether the event has been reviewed.

reviewedBy

string | null

The identifier of the user who reviewed the event, if applicable.

reviewedAt

date-time | null

The timestamp when the event was reviewed, if applicable.

markedAs

string | null

The status the event was marked as, if applicable.

markedBy

string | null

The identifier of the user who marked the event as valid or not valid, if applicable.

markedAt

date-time | null

The timestamp when the event was marked as valid or not valid, if applicable.

createdAt

date-time

required

The timestamp when the event was created.

updatedAt

date-time

required

The timestamp when the event was last updated.

media

array of objects

Media files associated with the event. This can include chip images and video clips.

media

view

object

Details of the camera associated with the event.

site

object

Details of the site associated with the event.

company

object

Details of the company associated with the event.

200Acknowledge receipt of the webhook