canonical: https://jentic.com/apis/signl4.com/signl4

# SIGNL4 API V1

<p>Use our API for systems integration or to build your own use cases. Sample scenarios include but are not limited to:</p><ul><li>2-way integration: Triggering of Signls and updates in the third party systems when alert state changes occur</li><li>Retrieving alarms for logging purposes</li><li>Calendar integrations: Creation and management of on-call duties</li><li>Punch users in and out based on. The API exposes 109 endpoints secured with apiKey, oauth2 authentication.

## For AI agents

Programmatically trigger alert, get alert. Covers 109 operations with apiKey, oauth2 authentication.

## Scope

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

## Capabilities

- Trigger Alert
- Get Alert
- Acknowledge an alert
- Annotate Alert
- Monitor SIGNL4 API V1 operational status and events

## Use cases

### Productivity Operations

Use the SIGNL4 API V1 to perform productivity operations programmatically. The API provides 109 endpoints covering core functionality including trigger alert, get alert, acknowledge an alert.

Example prompt: Call POST /alerts to trigger alert

### Automated Alerts Management

Automate alerts operations by combining multiple SIGNL4 API V1 endpoints. Agents can get alert and then acknowledge an alert in a single workflow.

Example prompt: Call GET `/alerts/{alertId}` to get alert, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SIGNL4 API V1 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 apiKey, oauth2 tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/alerts` | Trigger Alert |
| GET | `/alerts/{alertId}` | Get Alert |
| POST | `/alerts/{alertId}/acknowledge` | Acknowledge an alert |
| POST | `/alerts/{alertId}/annotate` | Annotate Alert |
| GET | `/alerts/{alertId}/annotations` | Get annotations of an alert |
| GET | `/alerts/{alertId}/attachments` | Get attachments of an alert |
| GET | `/alerts/{alertId}/attachments/{attachmentId}` | Gets a specified attachment of a specified alert. |
| POST | `/alerts/{alertId}/close` | Close an alert |

## Key resources

- **Alerts** — Provides access to all information about SIGNLs and the ability to interact with them.
- **Categories** — Provides access to services and system categories in a SIGNL4 team.
- **Duties** — Provide access to duty information and the ability to create, delete and update them.
- **Events** — Provide access to all information about events and their parameters.
- **Prepaid** — Provides access to the prepaid balance and transactions

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 47 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 65 / 100
  - Developer Experience & Jentic Compatibility: 68 / 100
  - AI-Readiness & Agent Experience: 24 / 100
  - Agent Usability: 82 / 100
  - Security: 52 / 100
  - AI Discoverability: 64 / 100
- **View full report:** https://jentic.com/apis/signl4.com/signl4/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring SIGNL4 by hand means choosing between its x-s4-api-key header and OAuth2 authorization-code auth with read and write scopes, and pointing calls at https://connect.signl4.com/api. Through Jentic you install once, import SIGNL4 from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** SIGNL4 puts the alert id in the URL path (`/alerts/{alertId}`), so a rule can pin your agent to one alert: it can acknowledge, annotate, and read that alert and nothing else. You choose the operations it may call, so closing an alert is not included unless you add it.
- **Credential handling:** Your SIGNL4 credential 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 'trigger an alert' or 'acknowledge an alert', and Jentic returns the matching SIGNL4 operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Asana** — Alternative productivity API
- **Monday** — Alternative productivity API
- **Clickup** — Complementary productivity API

## FAQ

### What authentication does the SIGNL4 API V1 use?

The SIGNL4 API V1 uses apiKey, oauth2 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 trigger alert with the SIGNL4 API V1?

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

### What are the rate limits for the SIGNL4 API V1?

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 trigger alert through Jentic?

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

### How many endpoints does the SIGNL4 API V1 have?

The SIGNL4 API V1 exposes 109 endpoints covering alerts, categories, duties operations.

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

Yes. Because Jentic One is self-hosted, you set the rules that decide which SIGNL4 operations and credentials your agent may use. SIGNL4 puts the alert id in the URL path (`/alerts/{alertId}`), so you can pin an agent to a single alert and allow only acknowledge, annotate, and read on it. Closing an alert or triggering a new one via POST /alerts stays off limits unless you explicitly add those operations.