Overview
This guide is intended for customers and third-party developers who want to integrate with Athena Security’s messaging API to send messages and alerts. The goal is to send alert messages—such as weapon detection alerts—to selected security groups and users associated with the groups on the account.
This is especially useful for organizations that require communication to dissemination of critical alerts through secure, automated messaging to smart glass devices.
The integration includes secure API key generation, group metadata export, and structured message dispatching and retrieving message statuses. This document outlines each step in detail, along with examples of payloads, headers, and responses.
Document Version: 1.3
Step 1: Generate API Key
To authenticate and use the API, you’ll first need to generate an API key.
Instructions:
- Login to the Athena Control Center
- Navigate to Integrations → Settings
- Under the API Keys section, click Create API Key
- Give your key a name (e.g., “Messaging Integration”) and click Create
- You can either:
- Export the key securely as a .txt file
- Or Copy the key directly
Security Tip: Store your API key securely.
Step 2: Export Group Details
To send messages to specific groups, you need their unique identifiers.
Instructions:
- From the Integrations page, select the groups tab
- Select one or more groups for message targeting
- Click Export
- Choose your preferred format: CSV or JSON
Example CSV Export
Example JSON Export
Step 3: API Authentication & Message Delivery
Endpoint
✅ Note: Include account_id in the URL.
Authentication Header
Example Alert Message Request
Message Format Guidelines
- May contain up to 5 lines
- Each line must be less than 23 characters
- Plain text only (no emojis, markdown, or special characters)
- Based on the number of groups, message objects are created and notified to glasses.
Success Response Example
Error Response Example
Step 4: Retrieving Message Status
- Message status can be retrieved from Athena security
- Respective Message id needs to be used in order to retrieve the statuses from Glasses.
- Based on the number of groups, message objects are created and notified to glasses.
- After a message is received for processing with /messages/send API, successful response is provided along with “message_id”.
- Use the message_id based on groups to retrieve statuses from glasses.
Endpoint
✅ Note: Include account_id and message_id in the URL. Use the API Key originated for the specific account.
Authentication Header
Get Status Response Example
Support & Contact
If you have questions or require integration assistance:
- 📧 Email: [email protected]
Document Info
Version: 1.3
Author: Athena Security Engineering Team