Creating Events and Alarms Using CHeKT's Cloud APIs

Creating Events and Alarms Using CHeKT's Cloud APIs

Info

Overview

This guide explains how dealers and tech companies can integrate third-party software with CHeKT to create events and alarms using our Cloud APIs. By following these steps, you can automate event creation in CHeKT based on triggers from your external systems.

Notes

Prerequisites

Step-by-Step Integration Guide

Step 1: Create a Bearer Token (API Key)

  1. Log in to your CHeKT dealer portal at https://dealer.chekt.com
  2. Navigate to Settings > API Keys or visit directly: https://dealer.chekt.com/settings/api-keys
  3. Click the "+ Create API Key" button (located in the top right corner)
  4. Provide a descriptive name for your API key (e.g., "Alarm System Integration")
  5. Save and securely store your API key - this will be your Bearer Token




AlertImportant: There are 5 Keys per account. Keys are viewable at the time of creation; they cannot be recovered later. If this key is lost, you will need to create a new access key. Treat your API key like a password. Store it securely and never share it publicly. 

Step 2: Add the Token to Your Third-Party Software

The method for adding the Bearer Token varies by platform, but generally follows these patterns:

Generic Steps:
  1. Access your third-party software's API Settings or Integration Configuration section
  2. Look for fields labeled:
    • "API Key"
    • "Bearer Token"
    • "Authentication Token"
    • "Authorization Header"
  3. Paste your CHeKT API key into the appropriate field
  4. If prompted for authentication type, select "Bearer Token" or "OAuth 2.0"
Common Platform Examples:

For Webhook-based Systems:

  • Navigate to webhook configuration
  • Add a custom header: Authorization: Bearer YOUR_API_KEY

For Automation Platforms (e.g., Zapier, Make, n8n):

  • Select "HTTP Request" or "Custom API Call"
  • Set Authentication Method to "Bearer Token"
  • Paste your API key

Step 3: Create Your Rule on the Third-Party Software

Define the trigger conditions that will create events in CHeKT:

  1. Access your third-party software's Rules Engine or Automation Settings
  2. Create a new rule/automation
  3. Define your trigger condition(s), such as:
    • Motion detected
    • Door/window opened
    • Alarm triggered
    • System armed/disarmed

Example Rule Logic:

IF: The Front Door cameras has a person loitering for 10 seconds
THEN: Send API call to CHeKT

Step 4: General steps to add the CHeKT API to Your Rule

Configure the API call within your rule:

  1. Select "API Call" or "Webhook" as the action
  2. Set the HTTP method to POST
  3. Enter the CHeKT API endpoint (seen in Step 5 below)
  4. Configure authentication headers
  5. Define the request body (payload)
    1. For optional advanced paramerters the body, review the CHeKT API documents here: https://public-apidoc-chekt.web.app/

Step 5: Use the CHeKT Events API

API Endpoint:

POST https://api.chekt.com/ext/v1/sites/{site_id}/zones/{zone_number}/events

Required Parameters:

  • {site_id} - Your CHeKT site identifier
  • {zone_number} - The specific zone number for the event
Authentication:

Use the CHeKT Bearer Token created in Step 1 above.

Finding Your Site ID and Zone Number

Site ID:

  1. Log in to https://dealer.chekt.com
  2. Navigate to your sites list
  3. The Site ID is displayed in the General Tab or URL

Zone Number:

  1. Access the specific site
  2. Navigate to Site Details > Devices> Channel configuration
  3. Locate the zone number for the area you want to monitor

Testing Your Integration

  1. Test the API Key:
    • Use a tool like Postman or cURL to test authentication
    • Verify you receive a successful response (200 OK)
  2. Create a Test Event:
    • Manually trigger your third-party rule
    • Check the CHeKT Monitoring Portal for the site for the new event
    • Verify event details are correct
  3. Monitor API Usage: