Skip to content

Commit

Permalink
Merge pull request #488 from ferozsalam/update-exotel-docs
Browse files Browse the repository at this point in the history
Tidy Exotel alerter docs
  • Loading branch information
jertel committed Sep 26, 2021
2 parents 9726fcf + 10f8cb9 commit 7072b92
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
- [OpsGenie] Clarify documentation for URL endpoint to use in European region - [#475](https://github.com/jertel/elastalert2/pull/475) - @nsano-rururu
- [Docs] The documentation has been updated as the name of Amazon Elasticsearch Service has changed to Amazon OpenSearch Service. - [#478](https://github.com/jertel/elastalert2/pull/478) - @nsano-rururu
- [Tests] Improve test coverage of tencentsms.py - [#479](https://github.com/jertel/elastalert2/pull/479) - @liuxingjun
- [Docs] Tidy Exotel documentation - [#488](https://github.com/jertel/elastalert2/pull/488) - @ferozsalam

# 2.2.1

Expand Down
21 changes: 11 additions & 10 deletions docs/source/ruletypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1986,32 +1986,33 @@ Example assets_dir, email_image_keys, email_image_values::
Exotel
~~~~~~

Developers in India can use Exotel alerter, it will trigger an incident to a mobile phone as sms from your exophone. Alert name along with the message body will be sent as an sms.
Developers in India can use the Exotel alerter, which can send an alert to a mobile phone as an SMS from your ExoPhone. The SMS will contain both the alert name and the specified message body.

The alerter requires the following option:

``exotel_account_sid``: This is sid of your Exotel account.
``exotel_account_sid``: The SID of your Exotel account.

``exotel_auth_token``: Auth token assosiated with your Exotel account.
``exotel_auth_token``: The auth token associated with your Exotel account.

If you don't know how to find your accound sid and auth token, refer - https://support.exotel.com/support/solutions/articles/3000023019-how-to-find-my-exotel-token-and-exotel-sid
Instructions for finding the SID and auth token associated with your account can be found `on the Exotel website
<https://support.exotel.com/support/solutions/articles/3000023019-how-to-find-my-exotel-token-and-exotel-sid>`_.

``exotel_to_number``: The phone number where you would like send the notification.
``exotel_to_number``: The phone number to which you would like to send the alert.

``exotel_from_number``: Your exophone number from which message will be sent.
``exotel_from_number``: The ExoPhone number from which the alert will be sent.

The alerter has one optional argument:

``exotel_message_body``: Message you want to send in the sms, is you don't specify this argument only the rule name is sent
``exotel_message_body``: The contents of the SMS. If you don't specify this argument, only the rule name is sent.

Example usage::

alert:
- "exotel"
exotel_account_sid: "Exotel Account sid"
exotel_account_sid: "Exotel Account SID"
exotel_auth_token: "Exotel Auth token"
exotel_to_number: "Exotel to Number"
exotel_from_number: "Exotel from Numbeer"
exotel_to_number: "Exotel to number"
exotel_from_number: "Exotel from number"

Gitter
~~~~~~
Expand Down

0 comments on commit 7072b92

Please sign in to comment.