Contact Sales
Demo Buy now
Home / Integration plugins / Uptime Kuma SMS Integration

+

Send SMS alerts from Uptime Kuma

Uptime Kuma alerts reach the person on duty as an SMS. SMSEagle sends them over its own cellular connection, so they don’t depend on internet access or a cloud service.

Consultation
Configuration

Native SMSEagle support in Uptime Kuma

Uptime Kuma supports SMSEagle natively. Select SMSEagle as the notification type, enter the device address and API token, and alerts start arriving by SMS.

Alerts for the monitors you choose

You attach the SMSEagle notification to the monitors you choose, such as websites, certificates or services.

Works without internet

SMSEagle sends alerts through its own SIM card straight to the mobile network, so they don’t depend on internet access or a cloud SMS provider.

How it works

1

Event Trigger

An Uptime Kuma monitor detects that a service is down (or back up).

2

Communication

Uptime Kuma’s built-in SMSEagle notification type sends an HTTP API request to the SMSEagle device over your local network.

3

Alert

SMSEagle delivers the alert over its own cellular connection, not through a third-party service, as an SMS to the recipient’s phone.

Set up in about 10 minutes

Setup is easy and should take about five minutes. Generate an API token in SMSEagle, select SMSEagle as a notification type in Uptime Kuma, and you’re done.

See setup steps

SMSEagle sends Uptime Kuma alerts to the right person by SMS, day and night.

No per-message fees

SMSEagle sends SMS through a regular SIM card, so you only pay for your mobile plan.

Alerts keep going if one carrier fails

On devices with two SIM cards from different operators, SMSEagle switches to the second one when the first operator’s network is down.

Alerts keep working even if one device fails

Two SMSEagle devices can work as an HA cluster: if one fails, the other takes over sending.

SMSEagle configuration

SMSEagle API

This integration will use the SMSEagle API (see details: SMSEagle API). API v2 is the REST API recommended for new integrations; API v1 is kept for compatibility with older systems.

  • Create an API key for a dedicated user in the web interface. Uptime Kuma supports both API versions, you choose the API type in the SMSEagle notification settings. Pick one of the two options below.

API v2 (recommended)

  1. Create a new user in SMSEagle (menu System > Users, user access level: “User”).
  2. Create an API key for that user:
    • go to Settings > Global settings > API and open the API v2 page
    • click Create API key, fill in Key name and select the user created above as Owner
    • Add access permissions in section Messages for: Send SMS
    • Add access permissions in section Calls for: Make a ring call, Make a TTS Advanced call (for voice alerting)
    • click Create key. The access token is shown only once, right after saving.

API v1

  1. Create a new user in SMSEagle (menu System > Users) with access level “User”.
  2. Grant API access to the created user:
    • go to Settings > Global settings > API and open the API v1 page
    • click Create API key, fill in Key name and select that user as Owner
    • Add access permissions in section Permissions for: Send SMS, Send to contact, Send to group
    • click Create key. The access token is shown only once, right after saving.

Uptime Kuma configuration

Installation

Docker:

docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1

Non-Docker:

https://github.com/louislam/uptime-kuma#-non-docker

  1. Go to Uptime Kuma local server URL
  2. Choose or add new Monitor
  3. Choose “Setup Notification”
  4. Notification Type > SMSEagle
  • enter parameter URL of SMSEagle: URL to your SMSEagle device (for example: https://mysmsdevice.example.com or http://10.10.0.105)
  • enter Access Token: SMSEagle API access token created in point above
  • enter Recipient Phone Number: recipient telephone number (or numbers separated with comma)
  • alternatively, you may enter Group Name: group name defined in SMSEagle Phonebook (remember to set the group as Public in SMSEagle)
  • Press button Create to save the configuration.

*more information can be found on Uptime Kuma website*

Explore SMSEagle Demo device

SMSEagle is a hardware & software solution that guarantees a swift delivery of your messages to designated recipients, whether it’s for notifications, alerts, or important updates.

After registering to a demo you get a remote access to our physical device NXS-9750.

  • 14-days free trial
  • Access to over 20 functionalities
Start 14-days trial

What is hardware
SMS Gateway?

Learn more

Learn more about
SMSEagle features

Explore all features