For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quick start

Connect a tool to ilert, route its alerts to an on-call responder, and page yourself with a real event.

This guide takes you from an empty account to a real alert on your phone. It takes about 10 minutes.

By the end you will have:

  • an alert source that receives events from your tools

  • an escalation policy that decides who gets paged, and when

  • verified notification channels on your own profile

  • a test alert that reached you, which you then resolve

Before you begin

  • An ilert account. Sign up if you do not have one.

  • Your phone, to receive and verify notifications.

  • A terminal with curl, if you want to send the test event yourself rather than through a monitoring tool.

Create an alert source

An alert source is the connection between a tool and ilert. It receives events, decides whether each one becomes an alert, and hands that alert to an escalation policy.

1

Open the alert source wizard

In the sidebar, go to AlertingAlert sources, then click Create new alert source.

2

Select an integration

Pick the tool that will send events. Use the search box or the category filters to narrow the list.

If you are only testing, choose API — it accepts any JSON payload you send it, so you do not need a monitoring tool wired up yet. Email is the other good starting point, because almost every tool can send email.

Click Next.

3

Name it and assign a team

Give the alert source a name that identifies the system the alerts come from, not the tool that sends them — Checkout API tells an on-call responder more at 3am than Prometheus does.

Assigning a team is optional here, and controls who can manage the alert source and its settings. Click Next.

4

Choose who gets notified

Under Who should be notified about alerts?, either select an existing policy or choose Generate new escalation policy, which creates a basic policy that notifies you first.

When you select an existing policy, ilert previews the escalation chain underneath it, so you can confirm who is paged before any alert exists.

The Escalation step of the wizard. An existing policy named Acme Payments on-call is selected, and a preview shows the alert going first to the Acme Payments weekly rotation, escalating after 10 minutes to Helena Guzman and Humza Vega.
The preview shows the full escalation chain: the on-call rotation first, then two named responders after 10 minutes.

Click Next.

5

Choose how events are grouped

Grouping decides how many alerts a stream of events produces. Pick one:

Option
Behavior

Smart grouping (AI-powered)

Groups similar events by analyzing their content, within a grouping window you choose

Time-based grouping

Groups every event that arrives within a time window, or until the alert is accepted

Default grouping

Groups by the alert key that the integration sets

Auto-resolution is separate, and optional: it resolves alerts that stay open longer than the period you set.

None of this is permanent — change the grouping mode on the alert source at any time.

Click Continue setup.

6

Finish setup

The wizard hands you to the full settings page, where you can set alert templates, notification priority, and dynamic routing. None of it is required now.

Click Finish setup to save the alert source.

Until you click Finish setup, the alert source shows a FINISH SETUP badge in the list. It still receives events — the badge only marks that you have not been through the settings page.

Get your integration key

The alert source detail page has everything you need to send events.

The Settings tab of an alert source named Acme Refunds API, showing the team, the API integration type, a masked integration key with reveal and copy buttons, the API URL https://api.ilert.com/api/events, and the assigned escalation policy.
The integration key is masked by default. Use the eye icon to reveal it and the copy icon to copy it.

Copy the integration key. You will send it with every event.

Set up your notifications

An alert that pages nobody is not much use. Before you test, make sure ilert can reach you.

Open the user menu in the top right, then click Notification settings.

The Notification settings tab of My profile, listing email contacts, phone number contacts with call, SMS and WhatsApp channels, and registered push notification devices each with a Send test notification link.
Add and verify the channels you want to be paged on, then set notification rules below.
  1. Add and verify a phone number under Phone number contacts if you want calls or SMS.

  2. Install the mobile app for push notifications — iOS or Android — then use Send test notification to confirm the device works.

  3. Under Notification rules, set what happens when a high-priority alert is assigned to you, and how it differs from a low-priority one.

Send a test event

Replace YOUR_INTEGRATION_KEY with the key you copied, and run:

Only three fields are required: integrationKey, eventType, and summary. The Events API authenticates with the integration key in the body, so there is no Authorization header.

For JavaScript, Python, and the full field reference, see Creating alerts through events.

Confirm it worked

Go to Alerts in the top navigation and open the alert you just created.

An alert detail view titled Refund webhook backlog above threshold, showing status PENDING, its escalation policy, the responder Helena, high priority, and Accept, Escalate and Resolve buttons.
A newly created alert is PENDING and escalating. The timeline records every notification sent.

Check three things:

  • Status is PENDING — the alert is live and escalating.

  • Responders names the person the escalation policy picked. If your policy targets an on-call schedule, this is whoever is on call right now.

  • The Timeline on the right lists each notification as it goes out, including the channel it used.

Then finish the lifecycle:

  • Accept the alert to take ownership. This halts escalation — ilert treats an accepted alert as owned by a human and stops paging anyone else.

  • Resolve it when the underlying problem is fixed. A resolved alert cannot be reopened; a later event creates a new one.

What's next

Last updated

Was this helpful?