Skip to main content

Emergency alerts - integration with raptor alert

  • Updated

This article describes the configuration steps required in Raptor Alert to implement a working integration with Airtame devices. 

Pre-requisites: The Airtame Cloud configuration has been done, please read this article for step-by-step instructions: How to create integrations for emergency alerts?

This integration requires you to be a subscriber to Raptor Alert, the emergency initiation and mass communication application developed by Raptor Technologies. 

Create Credentials

You will need to create one credential per Airtame integration to be called by Raptor. The unique API key generated by Airtame Cloud will be used to authenticate calls coming from Raptor

  • Field configuration:
    • Name → provide a comprehensive name for easier troubleshooting
    • Type → API Key
    • API Key and Confirm API Key → paste the API key provided by Airtame Cloud for your endpoint
       

Create Configurations

  • Create at least one Raptor Connect configurations (https://apps.raptortech.com/v7/client/admin/raptor-connect/configurations) to be able to initiate alerts
    • Configurations is the object where the message payload and call URL are defined
    • Important fields:
      • Name → to easily identify your configuration inside Raptor
      • Credential → select the credential that contains the appropriate API Key for the destination URL
      • Method → POST in our context
      • Destination URL → Webhook URL provided by Airtame Cloud
      • Rule → to define which type of alerts should target this destination URL
      • Payload → the message structure
        • Follow this template for a quick implementation → TBD
           

Standard Response Protocol - recommended implementation

Configuration - Event information

  • Configuration type: set to Emergency
  • Name: provide an identifiable name for this configuration
  • Credential: select the credential (Api Key provided by Airtame Cloud) associated with the Destination URL.
  • Method: set to POST
  • Copy the URL provided by Airtame Cloud

Configuration - Rules

  • Toggle the Advanced mode feature
  • In rules field: {"==":[1,1]}
    • This rule means that this message will always be triggered when an Emergency incident is initiated or resolved
  • In the Payload:
{
"template": "{# INCIDENT_TYPENAME #}",
"headline": "{# INCIDENT_TYPENAME #}",
"description": "{# INCIDENT_SUBTYPENAME #}",
"status": "{# INCIDENT_STATUS #}",
"id": "{# INCIDENT_ID #}",
"isDrill": false
}
  • INCIDENT_TYPENAME → returns the incident type selected from Raptor
  • INCIDENT_SUBTYPENAME → returns the sub-type name selected from Raptor
  • INCIDENT_ID → generated from Raptor

This configuration will trigger any type of alert onto Airtame screens.

Drill Management - recommended implementation

Configuration - Event information

  • Configuration type: set to Drill
  • Name: provide an identifiable name for this configuration
  • Credential: select the credential (Api Key provided by Airtame Cloud) associated with the Destination URL.
  • Method: set to POST
  • Copy the URL provided by Airtame Cloud

Configuration - Rules

  • Toggle the Advanced mode feature
  • In rules field: {"==":[1,1]}
    • This rule means that this message will always be triggered when a Drill incident is initiated or resolved
  • In the Payload:
{
 "template": "{# INCIDENT_TYPENAME #}",  
"headline": "{# INCIDENT_TYPENAME #}",
  "description": "{# INCIDENT_SUBTYPENAME #}",
  "status": "{# INCIDENT_STATUS #}",
  "id": "{# INCIDENT_ID #}",
 "isDrill": true

}

Multi-Location configuration - recommended implementation

In some context, you may want to target specific locations for specific messages. For example: only notify Campus A when something happens on Campus A. Below are some configuration recommendations to handle this use case: 

In Airtame Cloud: 

In Raptor: 

  • Create as many configurations as target locations in your Airtame organization. For example: Campus A alerts, Campus B alerts,...
  • Provide the appropriate URL and associated credentials (API Key) for each URL
  • Under the Rules section:
    • Select the applicable building
    • Enable advanced mode -> the selected building must appear as BuildingUid variable in the Rules field
    • In the Payload field:
{
"template": "{# INCIDENT_TYPENAME #}",
"headline": "{# INCIDENT_TYPENAME #}",
"description": "{# INCIDENT_SUBTYPENAME #}",
"status": "{# INCIDENT_STATUS #}",
"id": "{# INCIDENT_ID #}",
"isDrill": false
}

Configuration guideline for customized Raptor configuration

The Raptor and Airtame integration is optimized for customers using the Standard Response Protocol (SRP) as their Emergency Management framework. When incidents are triggered in Raptor, the incident name is matched against predefined values expected by the Airtame API. This ensures the correct alert screen is displayed consistently across Airtame-powered devices.

By default, Raptor follows the Standard Response Protocol. The integration with Airtame is designed to work seamlessly with this standard configuration. However, both platforms are flexible enough to support custom Emergency Management policies and incident types that may deviate from SRP.

Recommended Setup for Non-Standard Configurations

To ensure reliable behavior when using custom incident types, we recommend the following approach:

  • Create a separate integration for each incident type. This helps manage different alert scenarios clearly and independently.
  • Define rules to trigger only for the specific incident type. Use conditions in the "Rule" field to target the appropriate incident.
     
  • In the payload, hardcode the template value to match one of the incident names recognized by the Airtame system. This guarantees the correct screen template is displayed, even for custom incident types.
  • Use the INCIDENT_TYPENAME and INCIDENT_SUBTYPENAME variables in the headline and description fields. This ensures that the actual incident name and subtype are still visible to viewers on the Airtame screen, preserving clarity.

Related articles