Alerts

To setup a webhook,

  1. Add a webhook from <a href='/settings/webhook/list'>Web-hooks</a>.
  2. Use the webhook on the <a href='/settings/alert/list'>Alert</a> page.
  3. When the alert is triggered, data is sent to the webhook.

The following describes the json payload received by the webhook. This endpoint is expected to not have an authentication mechanism and it can be secured by limiting the allowed origins (this server).

post/api/v1/webhooks/receiver-example/

Request

  • Base URL: https://docs.parkpow.com (the document declares no server; this is the origin it was published from)
  • URL: https://docs.parkpow.com/api/v1/webhooks/receiver-example/
  • Auth: none declared

Request body

alert_namestring required

Name of the alert template.

alert_tagsstring required

The matching vehicle tags as configured in the alert template.

timestring required

Time of the visit in local time.

timezonestring required

Timezone as configured in user preferences.

sitestring required

Name of the Parking Lot.

camerastring required

Internal ID of the camera.

camera_codestring required

Unique camera identifier.

camera_namestring required

Human-readable camera name.

spot_tags_matchedstring required

The matching parking spot tags.

license_platestring required

License Plate number of the vehicle

visitsinteger required

The total count of visits by the vehicle.

confidence_levelnumber double required

Confidence level of the engine

vehicle_idinteger required

Id of the vehicle

vehicle_typestring required

Type of the vehicle

vehicle_tagstring required

Vehicle's tags

vehicle_makestring required

Vehicle's making

vehicle_modelstring required

Model of the vehicle

vehicle_urlstring required

URL of the vehicle

vehicle_colorstring required

Color of the vehicle

messagestring required

Alert's message

photostring uri required

Link to the visit's image

visit_start_datastring json required

Additional data related to the start of the vehicle's visit. For the structure of the data, please refer to the start_data/end_data field of <a href='/documentation/#tag/Visits/operation/Visit%20Details'>Visit-Detail API</a> page.

visit_end_datastring json required

Additional data related to the end of the vehicle's visit.

visit_idinteger required

Id of the visit

visit_timestampstring required

Timestamp of the visit

visit_timestamp_isostring required

ISO formatted timestamp of the visit

use_fallback_directionboolean required

Use vehicle orientation when direction data is missing. (Front = 270, Rear = 90)

Response

Only the status-code is checked. The response body can be empty.

Changes

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