Wazuh SMS & voice call alerting – integration manual

Here we describe how to set up Wazuh SMS & voice call (ring and text-to-speech) alerts. The integration uses SMSEagle Hardware SMS Gateway. The process is easy and should take 10-15 minutes to complete.

SMSEagle is an offline hardware SMS gateway. Therefore no external connection to 3rd party system is required. All alerts are generated on-premise and sent directly to a cellular network. This solution can be used in secure installations, without Internet access.

SMSEagle Setup

Create a new user in SMSEagle (menu Users > + Add Users, user access level: “User”).
Grant API access to the created user:
- click Access to API beside the newly created user.
- Enable APIv2
- Generate new token
- Add access permissions in section Messages for: Send SMS
- Add access permissions in section Modem for: Make a ring call, Make a TTS Advanced call (for voice alerting)
- Save settings.

Wazuh Alerting - SMS Setup

Creating new Channel
a) Go to Notifications > Channels menu, and create New channel
b) Select Custom Webhook with POST Method
c) In the Webhook URL paste: https://smseagle-ip/api/v2/messages/sms
(where smseagle-ip is an actual IP address of your own SMSEagle device)
d) In Webhook headers add two keys:
access-token and as a value paste the access token for the SMSEagle APIv2
Content-Type and as a value paste: application/json

2. Creating new Alert
a) Go to Alerting -> Monitors
b) Define new action that triggers when you would like to send an alert. Select previously created SMS channel
c) In the Message field add your alert message in JSON format.

For example:

{ "to": ["+48111222333"],
"text": "Wazuh Alert: {{ctx.monitor.name}} just entered alert status. Please check the issue.
Trigger: {{ctx.trigger.name}}
Severity: {{ctx.trigger.severity}}
PeriodStart: {{ctx.periodStart}}"
}

{ "to": ["admin-group"], 
"text": "Wazuh Alert: {{ctx.monitor.name}} just entered alert status. Please check the issue. 
Trigger: {{ctx.trigger.name}} 
Severity: {{ctx.trigger.severity}} 
PeriodStart: {{ctx.periodStart}}" 
}

You can use a phone number (for example +48111222333) or a group defined in SMSEagle Phonebook (for example admin-group) as recipient.

That’s it! 😊SMS alerts are ready!

Wazuh Alerting - Ring Calls Setup (optional)

Here is how to set up ring calls (wake-up calls) on Wazuh. This is an easy way to draw someone’s attention in an emergency situation.
Notice: Voice functions are only available to users who have purchased the VOICE add-on for their SMSEagle device.

Creating new Channel
a) Go to Notifications > Channels menu, and create New channel
b) Select Custom Webhook with POST Method
c) In the Webhook URL paste: https://smseagle-ip/api/v2/calls/ring
(where smseagle-ip is an actual IP address of your own SMSEagle device)
d) In Webhook headers add two keys:
access-token and as a value paste the access token from the previously created user
Content-Type and as a value paste: application/json

2. Creating new Alert
a) Go to Alerting -> Monitors
b) Define new action that triggers when you would like to send an alert. Select previously created channel
c) In the Message field add your alert message in JSON format.

For ring (wake-up call):

{ "to": ["+48111222333"],
  "duration": 20,
}

or if you want to call a group defined in the SMSEagle Phonebook:

{ "groups": [12],
  "duration": 20,
}

Insert the correct group id from SMSEagle web-GUI > Phonebook > Groups. Duration means how long SMSEagle will call.

Wazuh Alerting - Voice Calls (with Text-to-Speech) Setup (optional)

Here is how to set up voice calls with offline text-to-speech conversion on Wazuh.
Notice: Voice functions are only available to users who have purchased the VOICE add-on for their SMSEagle device.

Creating new Channel
a) Go to Notifications > Channels menu, and create New channel
b) Select Custom Webhook with POST Method
c) In the Webhook URL paste: https://smseagle-ip/api/v2/calls/tts_advanced
(where smseagle-ip is an actual IP address of your own SMSEagle device)
d) In Webhook headers add two keys:
access-token and as a value paste the access token from the previously created user
Content-Type and as a value paste: application/json

For ring (wake-up call):

{ "to": ["+48111222333"],
  "voice_id": 2,
  "text": "Wazuh Alert: {{ctx.monitor.name}} just entered alert status. Please check the issue. Trigger: {{ctx.trigger.name}} Severity: {{ctx.trigger.severity}} PeriodStart: {{ctx.periodStart}}" 
}

or if you want to call a group defined in the SMSEagle Phonebook:

{ "groups": [12],
  "voice_id": 2,
  "text": "Wazuh Alert: {{ctx.monitor.name}} just entered alert status. Please check the issue. Trigger: {{ctx.trigger.name}} Severity: {{ctx.trigger.severity}} PeriodStart: {{ctx.periodStart}}"  
}

Insert the correct group id from SMSEagle web-GUI > Phonebook > Groups. Voice_id is a language model ID (English = 1)

What is hardware
SMS Gateway?

Learn more about
SMSEagle features

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