Introduction

With Client Sites that are registered as Alarm Organization, you can next define other Client Sites as Alarm Connections for that that Alarm Organization. This association enables some uniqueness in identifiers and associations  with an Alarm Custom Identifier and a Job Type (task-type in the API) to categorize it and prefer a Report Template. 

An example Alarm Connection via the API:

[GET] /alarm-connections/9

{
        "customId": "FloristDispatch",
        "alarmOrganization": 687,
        "client": 854,
        "defaultTaskType": 51,
        "status": "ACTIVE",
        "id": 9
}

Creating an Alarm Connection

Creating an Alarm Connection is nearly as simple as its default payload:

[POST] /alarm-connections

{
        "customId": "FloristDispatch",
        "alarmOrganization": 687,
        "client": 854,
        "defaultTaskType": 51
}

customId : Any identifier you like. This can be for identifying these connections internally, or related to an integration with another system.

alarmOrganization : This is a Client Site that has the "alarm organization" property set. (From the Dispatch settings of the site)

client : This is the Client Site to associate as being served by the Alarm Organization (like a parent Client Site responsible for dispatch)

defaultTaskType : When creating Alarms via the /alarms endpoint, you typically don't need to define the Task Type/Job Type for the category of the dispatch, since it can be defined here as part of the Client Site that can be dispatched to, via Alarm Connection, to an Alarm Organization.