How to use Alertify’s Open API

How to use Alertify’s Open API

Welcome to Alertify's developer documentation, where you'll find everything you need to understand and use our Open API. This includes:

  • Authentication: Learn how to securely log in and access the API.

  • Overview of Alertify Architecture: Get a clear understanding of how our system is structured.

  • API Specification: Detailed information on how to use the API effectively.

To access Alertify’s Open API, visit: https://api.alertify.io/openapi/ 


Alertify’s Open API is a token-based API that allows you to build custom integrations with your own applications or Property Management System.


Step 1: Generate an API Key On Alertify’s dashboard

Creating an API key is straightforward. You can generate multiple keys, which enable you to obtain authentication tokens for accessing different API endpoints. 


Follow these easy steps to generate your first API key:


  1. Login to your Alertify dashboard at https://dashboard.alertify.io/authentication/login 

  2. Go to ‘Settings’ on the menu 


  1. Then click on ‘Open API’ on the top menu


  1. The, click on ‘Add New Key’ 


  1. Give your API a name and then click on ‘Add’


Step 2: Get an API token on Alertify's Open API

Once you have an Api Key, you can use it to get an authentication token. This allows you to securely access various API endpoints.


(1) Go to the following link: https://api.alertify.io/openapi/ 


(2) Then, scroll down to ‘Authentication’ on the left navigation bar



(3) Under ‘Get API token’, click on the ‘Fill Example’ button, and then paste your API key from your Alertify dashboard where the text ‘String’ is, so it looks like the following: 



(4) Then click on the ‘Try’ button. Your API code will appear in green text. Copy the green text only without the quotation marks. 


(5) Once your API key is copied, scroll to the top to ‘Authentication’, add 'Bearer' with a space and then paste your API key in the small textbox and click ‘Update’. This will give you access to various API endpoints in the dashboard. 




That’s it - you’re all done!


Need Further Assistance?

If you encounter any issues or require further assistance, please don't hesitate to reach out to our dedicated support team at support@alertify.io. We're here to help you make the most out of your Alertify experience.



    • Related Articles

    • How to Add Your Alertify Dashboard to Your Home Screen

      The Alertify mobile app is designed to streamline the setup process — helping you connect your device to the dashboard quickly and ensuring you receive important push notifications for violations. While the app excels at setup and alerts, the web ...

    • Alertify Cancellation, Refund, and Return Policy

      1. Payment and Subscription Renewals Payment for the subscription occurs automatically and annually through our payment gateway partner. Subscribers must provide accurate billing information, including name, billing address, and payment details. Once ...

    • How to integrate with Lodgify

      Use Alertify's integration functions to simplify Integrating Lodgify with Alertify allows you to seamlessly track guest information and ensure accurate after-incident reporting. By connecting your Lodgify account to Alertify, you’ll know which guests ...

    • How to integrate with Uplisting

      Overview Connecting Uplisting to your Alertify dashboard allows you to seamlessly track which Alertify devices are assigned to which unit and monitor which guests are staying in your units at any given time. This integration streamlines the process ...

    • What your Alertify device’s LEDs mean

      The LEDs on your Alertify device provide important information about its status. Here’s a quick guide to understanding what the different LED colors and patterns indicate. Device Not Setup When the device is not yet set up, the LEDs will display the ...