canonical: https://jentic.com/apis/swaggerhub.rjericho/tg-alerter

# Rjericho TG alerter

This is a sample telegram alerter. The API exposes 11 endpoints.

## For AI agents

Programmatically send message to user or group, add a new group. Covers 11 operations.

## Scope

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

## Capabilities

- Send message to user or group
- Add a new group
- Get all groups
- Delete user to group relation
- Find user by ID

## Use cases

### Developer Tools Operations

Use the TG alerter to perform developer tools operations programmatically. The API provides 11 endpoints covering core functionality including send message to user or group, add a new group, get all groups.

Example prompt: Call POST /alert to send message to user or group

### Automated users Management

Automate users operations by combining multiple TG alerter endpoints. Agents can add a new group and then get all groups in a single workflow.

Example prompt: Call POST `/api/groups` to add a new group, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call TG alerter 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 'send message to user or group', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/alert` | Send message to user or group |
| POST | `/api/groups` | Add a new group |
| GET | `/api/groups` | Get all groups |
| POST | `/api/groups/useradd` | Add user to group |
| POST | `/api/groups/userdel` | Delete user to group relation |
| GET | `/api/groups/{groupId}` | Find user by ID |
| DELETE | `/api/groups/{groupId}` | Deletes a group |
| POST | `/api/users` | Add a new user |

## Key resources

- **users** — Work with users
- **groups** — Work with groups
- **alert** — Send message

## Why Jentic

- **Setup:** Wiring TG alerter by hand means standing up its base host and handling requests and retries yourself, even though it ships no auth scheme. Through Jentic you install once, import TG alerter from the API Directory, store any connection details once, and your agent calls it.
- **Permission scoping:** TG alerter puts the group id in the URL path (`/api/groups/{groupId}`), so a rule can pin your agent to one group: it can read that group and nothing else. You choose the operations it may call, so writes like adding or removing users or deleting a group are not included unless you add them.
- **Credential handling:** Any TG alerter connection detail 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 'send an alert message' or 'list groups', and Jentic returns the matching TG alerter 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 TG alerter use?

The TG alerter 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 send message to user or group with the TG alerter?

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

### What are the rate limits for the TG alerter?

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 send message to user or group through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'send message to user or group'. Jentic returns the matching TG alerter operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the TG alerter have?

The TG alerter exposes 11 endpoints covering users, groups, alert operations.

### Can I limit what my agent is allowed to do with the TG alerter?

Yes. Because you run Jentic One yourself and self-host the execution layer, your own rules decide which TG alerter operations and connection details the agent may use. Since the group id sits in the URL path (`/api/groups/{groupId}`), you can pin the agent to a single group and let it only read that group with GET `/api/groups/{groupId}.` Write operations such as sending alerts via POST /alert, adding or removing members via `/api/groups/useradd` and `/api/groups/userdel`, or deleting a group are excluded until you explicitly allow them.