Log Management
Alerting
Destinations
SMSEagle

SMSEagle

Use an on-prem SMSEagle device as your SMS path for critical alerts. Configure smseagle with device URL, credentials, and recipient groups. Add smseagle under alert: on your rule (you can combine destinations).

Options covers each YAML field—required first—with snippets under some keys. Full working example at the bottom is a complete rule for the Logit.io alert editor.

Options

Keys below match the ElastAlert 2 alerter. Shared rule fields such as alert_subject apply as described in Subject & body. Example fragments from the ElastAlert 2 reference appear indented under the option they illustrate (add your own name, type, index, and filter to make a full rule).

Required

  • smseagle_url — Address of your SMSEagle device, e.g.

Example usage

 alert:
   - "smseagle"
 smseagle_url: "https://192.168.1.101"
 smseagle_token: "123abc456def789"
 smseagle_message_type: "sms"
 smseagle_to: ["+123456789", "987654321"]
 smseagle_contacts: [2, 7]

  • smseagle_token — API access token (per user, can be generated in menu Users > Access to API)

  • smseagle_message_type — Message/call type to send/queue. Available values: sms, ring, tts, tts_adv respectively for SMS, Ring call, TTS call and Advanced TTS call. Requires one of:

  • smseagle_to — Phone number(s) to which you want to send a message

  • smseagle_contacts — Name(s) of contact(s) from the SMSEagle Phonebook to which you want to send a message

  • smseagle_groups — Name(s) of group(s) from the SMSEagle Phonebook to which you want to send a message

Optional

  • smseagle_duration — Call duration, required for Ring, TTS and Advanced TTS call. Default value: 10

  • smseagle_voice_id — ID of the voice model, required for Advanced TTS call. Default value: 1

  • smseagle_text — Override notification text with a custom one

Full working example

name: Example alert for SMSEagle
type: any
index: "*-*"
filter:
  - query:
      query_string:
        query: "level:error OR log.level:error"
alert:
  - "smseagle"
smseagle_url: "https://smseagle.example"
smseagle_token: "REPLACE"
smseagle_message_type: sms
smseagle_to:
  - "+441234567890"
SlackSplunk On-Call (VictorOps)