> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# SIGNL4 API

> Page your on-call technicians from a ticket with SIGNL4, read when each alert was delivered and acknowledged, and manage duty, shifts and teams

The common use is an after-hours escalation: an agent pages the technicians on duty about an urgent ticket, and a later run writes on the ticket when the alert went out, when it was acknowledged and by whom, and when work on the ticket began.

> [!NOTE]
>
> Automatically enabled when you configure SIGNL4 permissions in your agent workflow, or on a dashboard.

## What It Does

* Raise an alert to a team, with the ticket's title, details, priority and an external id that ties the alert to the ticket
* Read an alert's timeline: when it was raised, delivered to each person by push, SMS, voice or email, acknowledged, escalated and closed, and by whom
* Acknowledge, annotate, escalate to another team and close alerts
* Read who is on call now and on a date: duty status, schedules, shifts and absences; put a technician on or off duty
* Read and change users, teams and memberships, categories, signaling patterns, alert templates, connector apps, outbound webhooks and remote actions
* Read the subscription, its licences, invoices, prepaid balance and the audit log

## Permission Groups

| Group | Covers |
| - | - |
| Alerts & Events | Alerts (Signls) and events: raise, read, acknowledge, annotate, escalate and close them; their timeline, notifications, escalations, summaries and reports |
| On-Call Duty & Shifts | Duty status, punching in and out, duty schedules, shifts and their assignments, absences, holidays and duty reports |
| Users, Teams & Access | Users and their profiles, contact numbers, notification profiles and tags, teams and memberships with their roles, invitations, stakeholders, distribution lists and SCIM settings |
| Alert Setup & Routing | Categories and their keywords, signaling patterns and settings, event sources, alert templates and workflows |
| Connectors, Webhooks & Remote Actions | Connector apps and their inventory, outbound webhooks, remote actions, their jobs and journal |
| Subscription, Billing & Audit | The subscription, its settings, features, licences and channel prices, invoices, prepaid balance and settings, and the audit log |

## Access Profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | No write is allowed |
| **Helpdesk** | Every read | Raising and working alerts, and changes to who is on duty; no other write is allowed |
| **IT Admin** | Every read, and alert and on-call changes outside [Safety Controls](#safety-controls) | Changes to users and teams, alert setup, connectors and webhooks, and the subscription, and the changes in [Safety Controls](#safety-controls) |
| **Full Automation** | Every read and write outside [Safety Controls](#safety-controls) | The changes in [Safety Controls](#safety-controls) |

## Safety Controls

| Control | Behavior |
| - | - |
| **Always asks** | Changing a password, deleting a team, deleting a user (SIGNL4 deletes the whole subscription with its last user), mailing a user the team's event sources, and a write that sends a password, key, token, PIN or a connector's settings always ask a technician, whatever the profile |
| **Alerts named by id** | Neo acknowledges or closes several alerts only by their ids, and never every alert a filter selects |
| **Credentials in answers** | Neo hides passwords, keys, tokens and PINs, each connector app's settings, the inbound webhook URLs and email addresses that carry a team secret, and URLs that carry a credential, before the agent reads an answer |
| **Refused calls** | Neo never generates the SCIM API key, and does not upload images or alert attachments |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.