canonical: https://jentic.com/apis/swaggerhub.igtbdigital/alerts

# Igtbdigital Alerts

This API is to be used to emit an Alert event to the Alert engine by any alert services consumting consuming application. The API exposes 1 endpoints.

## For AI agents

Programmatically raisealert. Covers 1 operations.

## Scope

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

## Capabilities

- raisealert
- Manage developer tools data programmatically
- Integrate Alerts into automated workflows
- Query and filter Alerts records by parameters
- Monitor Alerts operational status and events

## Use cases

### Developer Tools Operations

Use the Alerts to perform developer tools operations programmatically. The API provides 1 endpoints covering core functionality including raisealert.

Example prompt: Call POST /v1/common/raisealert to raisealert

### Data Retrieval and Monitoring

Query Alerts 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 Alerts endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call Alerts 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 none tokens manually.

Example prompt: Search Jentic for 'raisealert', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /v1/common/raisealert | raisealert |

## Key resources

- **Raise Alerts** — Operations related to Raise Alerts

## Why Jentic

- **Setup:** Wiring the Alerts API by hand means reading its spec, standing up an HTTP client against the raise-alert endpoint, and handling request formatting and retries yourself. Through Jentic you install once, import Alerts from the API Directory, store any required connection detail once, and your agent calls it.
- **Permission scoping:** This spec exposes a single operation, POST /v1/common/raisealert, so you limit the agent to the operations it needs: here that is raising an alert, and nothing else runs unless you add it. You decide which operations are in the allowed set, framing the agent's reach as your own positive choice.
- **Credential handling:** Any connection detail the Alerts API needs is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'raise an alert', and Jentic returns the matching Alerts operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Alerts use?

The Alerts uses no authentication. 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 raisealert with the Alerts?

Yes. Use the POST /v1/common/raisealert endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Alerts?

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 raisealert through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'raisealert'. Jentic returns the matching Alerts operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Alerts have?

The Alerts exposes 1 endpoints covering raise alerts operations.

### Can I limit what my agent is allowed to do with the Alerts API?

Yes. Jentic One is self-hosted, so you run the execution layer and your own rules decide which operations and credentials the agent may use. The Alerts API exposes a single operation, POST /v1/common/raisealert, so you can keep the agent's allowed set to just raising an alert and nothing else runs unless you add it. You choose which operations sit in that allowed set, and connection details are injected only at execution time rather than exposed to the agent.