API docs by Redocly

Alarmbridge Connect Service - API Overview

Download OpenAPI specification:Download

API Overview

The Alarmbridge Connect Service APIs provide robust tools for provisioning, configuring, and managing devices and alarm communication workflows within the Alarmbridge Connect ecosystem. These APIs support seamless integration, operational efficiency, and scalable deployment for group living schemes and other critical applications.

Service Provisioning API

The Service Provisioning API is essential for setting up and configuring the Alarmbridge Connect Service for your domain. It establishes the framework for alarm reception, event routing, and real-time notification management. By using this API, you can define callback URLs, configure service alarms, and ensure reliable alarm handling.

Main Endpoint:

  • PUT /notificationsettings/{domain}

    Configures destination URLs for service alarms and REST callbacks to handle real-time notifications. This ensures that critical alarms and service updates are delivered to the appropriate monitoring systems.

Alarmbridge Connect Gateway Device Provisioning API

This API is central to managing Alarmbridge Connect Gateway devices within a domain. It supports adding, updating, and removing devices, ensuring they are securely authenticated and properly configured for accessing the Alarmbridge Connect Service.

Main Endpoints:

  • POST /provisioning/device/{domain}

    Adds a new Gateway device to the specified domain. Configure details such as device ID, credentials, and service-specific settings to enable secure communication.

  • PUT /provisioning/device/{domain}

    Updates the configuration of an existing device within the domain. Adjust settings such as credentials, connection parameters, or other service-specific attributes as needed.

  • DELETE /provisioning/device/{domain}

    Deletes a device from the specified domain, removing it from the system and terminating its access to the Alarmbridge Connect Service.

Alarm Event Handling API

The Alarm Event Handling API enables configuration of event receivers and routing for alarm communication. This API allows you to define how alarm events are received, processed, and sent to their intended destinations.

Main Endpoints:

  • POST /provisioning/alarmbridge/{domain}

    Sets up the event receiver for the specified domain, enabling the Alarmbridge Connect Service to receive incoming alarm events. Configure the receiver\'s protocol and destination address (e.g., SIP address or phone number).

  • POST /provisioning/alarmeventmapper/{domain}

    Sets up the event sender to route alarm events to target destinations. Configure mappings for outgoing alarms to SIP addresses, phone numbers, or REST callback URLs to ensure compatibility with receiving systems.

These APIs offer a powerful and flexible interface for managing alarm communication systems, streamlining deployment, and ensuring reliable operation in critical environments.