Log in to see full request history

Webhooks
We know that operational efficiency is important for any organizations, and getting event data and details into your system is important. Webhooks is a great way to get this done.

Here is what the body will look like:

{"PropertyID":######,"PropertyName":"name_of_property","AlertTime":"2020-11-12T00:13:23.257234193Z","AlertType":"continuedNoise","AlertInfo":"ALERT: Noise Sensors at [PropertyName] has sustained noise above the NRS threshold. dashboard.noiseaware.io/properties/[APIKey]"}

Here are the alert types:
newNoise
continuedNoise
resolvedNoise
newAdvancedAlert
secondAdvancedAlert
thirdAdvancedAlert
resolvedAdvancedAlert
newDisconnect
resolvedDisconnect
newTamper
newLowBattery
newPropertyDisconnect
resolvedPropertyDisconnect
newConnectionIssue
resolvedConnectionIssue
continuedConnectionIssue

Body Params

webhook info

int64

webhook id

string
required

hook URL

boolean
required

send disconnect group notifications to webhook

boolean
required

send noise group notifications to webhook

int64
required

org id to attached webhook to

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.organizationwebhook.response+json