canonical: https://jentic.com/apis/swaggerhub.legrandcare/alma-event-notification

# Legrandcare ALMA Event notification

API to allow thirdparty systems to notify events to be sent to ALMA. The API exposes 1 endpoints secured with basic authentication.

## For AI agents

Programmatically notify an event related to a specific camera. Covers 1 operations with basic authentication.

## Scope

Does not handle payments, crm, or developer tools - use for communications only.

## Capabilities

- Notify an event related to a specific camera
- Manage communications data programmatically
- Integrate ALMA Event notification into automated workflows
- Query and filter ALMA Event notification records by parameters
- Monitor ALMA Event notification operational status and events

## Use cases

### Communications Operations

Use the ALMA Event notification to perform communications operations programmatically. The API provides 1 endpoints covering core functionality including notify an event related to a specific camera.

Example prompt: Call POST /camera/{camera_id} to notify an event related to a specific camera

### Data Retrieval and Monitoring

Query ALMA Event notification resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary ALMA Event notification endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call ALMA Event notification endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.

Example prompt: Search Jentic for 'notify an event related to a specific camera', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /camera/{camera_id} | Notify an event related to a specific camera |

## Key resources

- **cameras** — Notification of events related to cameras

## Why Jentic

- **Setup:** Wiring ALMA Event notification by hand means encoding HTTP basic auth, supplying your own host, and posting camera events yourself. Through Jentic you install once, import ALMA Event notification from the API Directory, store the basic credentials once, and your agent calls it.
- **Permission scoping:** ALMA Event notification puts the camera id in the URL path (/camera/{camera_id}), so a rule can pin your agent to notifying events for one camera. This is the only exposed operation, and you choose whether the agent may call it.
- **Credential handling:** Your ALMA Event notification basic credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'notify an event for a specific camera', and Jentic returns the matching ALMA Event notification operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the ALMA Event notification use?

The ALMA Event notification uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I notify an event related to a specific camera with the ALMA Event notification?

Yes. Use the POST /camera/{camera_id} endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the ALMA Event notification?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I notify an event related to a specific camera through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'notify an event related to a specific camera'. Jentic returns the matching ALMA Event notification operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the ALMA Event notification have?

The ALMA Event notification exposes 1 endpoints covering cameras operations.

### Can I limit what my agent is allowed to do with the ALMA Event Notification API?

Yes. Because Jentic One is self-hosted, you set the rules that decide which operations and credentials your agent may use. The API exposes only one operation, POST /camera/{camera_id}, so you choose whether your agent may call it at all. Since the camera id sits in the URL path, you can pin your agent to notifying events for a single camera and block the rest.