How it works


Subscribe to EZAlert.me service here, create a EZALert.me channel and get your "start code".
A start code is a string in the format XX-XXXXXXXX that you have to send to the instant messenger bot to let it know you are allowed to receive alerts from your channel.
In your channel configuration page you also find an API Key you will use to send messages to your EZAlert.me channel. API key is in the format YY-YYYYYYYYYYYY.
Where you find your channel start code

Add EZAlert.me BOT on your favourite instant messages platform. Supported platforms so far include: Telegram, Skype and Facebook Messenger. Send a message to EZAlert.me bot containing the word "start" plus your start code.

Example:

Start XX-XXXXXXXX



EZAlert.me Bot will reply with a subscription confirmation message.
You are now subscribed to your EZAlert.me channel.

Now that you subscribed to your EZAlert.me channel, you can enable your systems and programs to send alerts via the EZAlert.me RESTful API.
Call the API with a simple GET or POST to the API endpoint https://ezalert.me/v1/sendAlert passing the following parameters:

Example of GET call url:

https://ezalert.me/v1/sendAlert?apikey=YY-YYYYYYYYYYYY&text=test+alert

Sample alert received on Skype

This kind of API call is pretty simple and can be instantiated with any programming language, even within a Unix shell script:


#!/bin/bash

curl "https://ezalert.me/v1/sendAlert?apikey=YY-YYYYYYYYYYYY&text=Huston,+we+have+a+problem!"

Or in Windows Power Shell:


wget "https://ezalert.me/v1/sendAlert?apikey=YY-YYYYYYYYYYYY&text=Huston,+we+have+a+problem!"

That's all. Easy, isn't it? :-)


The device/software you want receive alerts from can't do API calls?
If it can send emails have a look at EZAlert.me email gateway, or check out our tutorial about WooCommerce sending instant messages on new orders.

If you need more info please have a look at EZAlert.me FAQ and bot commands pages, or have a look at samples about how to use EZAlert API on EZAlert.me GitHub. Git includes shell scripts, code snippets in various languages (PHP, Python, Perl, ..), and it also contains samples about how to use EZalert.me with Zabbix and Monit.

Want to receive alerts on Slack too? Learn how to configure EZAlert.me - Slack integration.