Integrations & API
Connect StacksAtlas to email, chat, syslog, OpenAVC room control, and your own scripts. Most day-two setup happens in Settings on the appliance. This page summarizes the options.
Email alerts (SMTP)
Settings → ALERTS drives mail for device down, new device, and security events. Use your own SMTP server (Office 365, Gmail app password, or an internal relay).
Minimum fields
| Field | Notes |
|---|---|
| Enable | Toggle the SMTP notification engine on. |
| SMTP HOST | Mail server hostname (e.g. smtp.office365.com). |
| PORT | Usually 587 (STARTTLS) or 465 (implicit TLS), per your provider. |
| USERNAME | SMTP login (often the mailbox address). |
| APP PASSWORD | SMTP password or app-specific password (never a StacksAtlas license key). |
- Fill the fields → Commit SMTP config.
- Enter a test address → Send test before relying on production alerts.
- Pair with per-user notification preferences under User management (All Network Events vs Only Devices I Manage).
On a federated Node, Hub sync alerts policy may make SMTP read-only until you Override locally.
REST API
The appliance exposes a local REST API (same machine or LAN).
- Scripts & CMDB: Generate long-lived
sa_tokens under Settings → INFRASTRUCTURE (Business only). - Security summary:
GET /api/security/auditfor aggregate grade counts.
Full endpoint reference lives in
/api-docs. We do not duplicate it here.Device asset fields (Business)
Track serial, asset tag, firmware, and warranty per device (drawer Overview → Asset). Export Asset fields CSV from the Devices toolbar, edit in Excel, then Import assets to bulk-update.
Import match keys
Match order for each row (first hit wins):
- Device ID (preferred; GUID from an Asset fields export)
- MAC Address (normalized)
- IP Address
On a Hub, optional Node ID narrows MAC/IP matches to one site when the same address exists in multiple fleets. Rows without Device ID, MAC, or IP are rejected.
Hub fleets sync asset fields like location. Linked OpenAVC devices can auto-fill serial/firmware when macros publish state. See OpenAVC Control Bridge below. Drawer and bulk clear tools: Device inventory.
OpenAVC Control Bridge (v1.8.5+)
StacksAtlas monitors; OpenAVC controls AV gear. Run both on the same site Node, link inventory rows in the device Controls tab, and trigger pinned macros from StacksAtlas.
Business permanent install only (not portable). Configure Settings → OPENAVC on each Node (not the Hub). Hub operators relay commands to the owning Node automatically.
Quick start
- Install OpenAVC on the site LAN (default API
http://127.0.0.1:8080). - Settings → OPENAVC: base URL, credentials, Test login.
- Devices → open a host → Controls → link OpenAVC device id.
- Pin macros you want operators to run → Save pins.
- Run macros or driver commands from the drawer.
Device readings
StacksAtlas reads OpenAVC device state, not the Activity log. If readings stay empty, update your OpenAVC macro to write device state (see OpenAVC: Variables and State).
After rediscovery recreates an inventory row, the same MAC reattaches the OpenAVC link automatically when possible.
Troubleshooting
| Symptom | Likely cause | Fix |
|---|---|---|
| Controls tab missing | Portable or free session | Business MSI / Mac Install / Docker appliance |
| Health: offline | OpenAVC down or wrong base URL | Start OpenAVC; verify host/port from the Node |
| Health: auth_failed | Bad credentials | Re-enter Settings → OPENAVC and Test login |
| No readings | Driver/macro not calling set_state | Fix in OpenAVC Programmer (device state) |
| Hub action fails | Wrong owning Node / relay | Confirm fleet ownership on the device row |
| Macro not listed | Not pinned | Pin macros in the drawer Controls tab |
Syslog (Business)
Stream discovery and security events to Splunk, Elastic, or any RFC5424 collector: Settings → INFRASTRUCTURE → enable Syslog & SIEM Export, set host and port (default UDP 514), Save & Restart.
Webhooks (Business)
Push alerts to Slack, Teams, Discord, or a custom HTTPS URL: Settings → ALERTS → Add Webhook. Use Test Webhook before enabling. Failed destinations trip a circuit breaker after repeated errors.
Webhook Alert Scope
Each webhook has an Alert Scope (independent of per-user notification preferences):
| Scope | Behavior |
|---|---|
| Global (All Devices) | Fires for matching trigger events on any device in scope of this appliance / Hub filters. |
| Targeted (Assigned to User) | Fires only for devices whose assigned manager is the user you pick on the webhook. |
User profiles still choose All Network Events vs Only Devices I Manage for which events that person receives. Webhook scope controls the destination. Pair them carefully so Slack/Teams channels are not flooded. See User management.
Related guides
- Infrastructure: API tokens, TLS, updates
- Device inventory: drawer tabs and bulk asset CSV
- Alerts: live events and history
- Getting Started: first-run paths