API & 3rd Party Integration
Terminology
-
- API: An API is an HTTP server endpoint that “System A” listens to. A third-party, “System B”, can then request that API endpoint to extract information from “System A”, in a request-reply on-demand fashion.
- Webhook: An outbound HTTP request that “System A” makes to “System B”. This is used in setups where it’s desirable that “System B” gets updated with information from “System A”, in an event-driven fashion, e.g. when information has been updated in “System A”.
YourSixOS Notification Webhooks
YourSixOS provides HTTP webhooks as a recipient of notifications. These notifications are security events sent to a designated receiver. Receivers can include users via email, organization email addresses, or webhook receivers. Examples of security events include motion detection and barrier forced open. Similar to how YourSixOS can send notifications to mobile devices, it can also notify third-party services via webhooks. For more details about the contents of these webhooks, please contact your account representative.
YourSixOS Central Station Integration
YourSixOS can send specific HTTP webhooks to central stations in order to raise alarms in the central station software. In addition to the central station webhooks, YourSixOS also offers a specific HTTP API for central stations.
The central station integration suite is granted only to strategic integration partners. For more information, reach out to your account representative.
Related Training Resources: