Share911 Help Center

Overview

Share911 can be configured to send data to a designated URL whenever certain events occur.  

For help configuring Webhooks for your organization please contact support@share911.com.


Configuring a Webhook

Payload URL

The payload URL is the secure (HTTPS) URL of the server that will receive the webhook POST requests.

Authentication

Include a username and password if the POST request should authenticate via Basic authentication.

Content Type

The JSON payload will be delivered directly as the body of the POST request using the application/json content type.

Broadcast Payload API

Examples

LOCKDOWN

{
  "_id" : "384a225c-17ac-45bd-aad5-2afda1c46173",
  "channelId" : "sharevilledemo/roosevelt",
  "channelName" : "Roosevelt High School",
  "customChannelIds" : ["104"],
  "alertName" : "Lockdown",
  "alertType" : 1,
  "message" : "test message 1",
  "timestamp" : "2019-10-24T16:39:42.486Z",
  "firstname" : "John",
  "lastname" : "Smith",
  "email" : "jsmith@example.com",
  "mobile" : "5555555555",
  "title" : "Principal",
}

ALL CLEAR

{
  "_id" : "57bc980e-077b-444c-aad7-428b7a2f5727",
  "channelId" : "sharevilledemo/roosevelt",
  "channelName" : "Roosevelt High School",
  "customChannelIds" : ["104"],
  "alertName" : "All Clear",
  "alertType" : 5,
  "resolution" : true,
  "message" : "Resume normal class schedule",
  "timestamp" : "2019-10-24T16:48:33.486Z",
  "firstname" : "John",
  "lastname" : "Smith",
  "email" : "jsmith@example.com",
  "mobile" : "5555555555",
  "title" : "Principal",
}

Broadcast Data Fields

_id

A UUID generated by Share911 for every alert; can be safely ignored but useful when tracing a specific alert's flow through the system.

channelId

Channel ID is the unique identifier of the communication channel on which the alert was broadcast. Typically each customer building will have its own channel in Share911.  The easiest way to find the Channel ID is on the Manage Channel => Channel Info page, under either Channel ID or Share ID.  You can also find the Channel ID by looking in the URL. For example, if I select the East Branch channel in Share911, the Channel ID is the "sharevilledemo/eastbranch" part of the URL:
https://share911.com/sharevilledemo/eastbranch

channelName

Customer-editable name for the communication channel on which the alert was broadcast.

customChannelIds

An array of codes privided by the customer or other 3rd-party supplier which identify the alert's source location. Usually they are the specific workplaces or building codes as defined in the customer's HR system but they can be any unique string.

alertName

The name of the alert in English. For example, "Lockdown".

alertType

A numeric ID which corresponds 1-to-1 with the "alertName". Can be used to avoid string comparison when identification of a specific alert type is required. Contact support@share911.com for a complete mapping of alert types to names.

resolution

A boolean value which is only included when the alert implies that the current incident is over, such as an All Clear.

message

The optional message supplied when the broadcast was initiated.

timestamp

The time the broadcast was initiated in ISO 8601 format.

firstname

The given name of the person who initiated the broadcast.

lastname

The family name of the person who initiated the broadcast.

email

The email address of the person who initiated the broadcast.

mobile

The mobile phone number of the person who initiated the broadcast.

title

The job title of the person who initiated the broadcast.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

Related Articles