Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tidy Twilio documentation #363

Merged
merged 2 commits into from
Jul 24, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Tidy Twilio documentation
  • Loading branch information
ferozsalam committed Jul 24, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit baa92c37ab0bd33858a35e0447882c1a7ae965fa
26 changes: 15 additions & 11 deletions docs/source/ruletypes.rst
Original file line number Diff line number Diff line change
@@ -2859,28 +2859,32 @@ Example usage::
Twilio
~~~~~~

Twilio alerter will trigger an incident to a mobile phone as an sms from your twilio phone number. The sms will contain the alert name. You may use either twilio SMS or twilio copilot
to send the message, controlled by the ``twilio_use_copilot`` option.
The Twilio alerter will send an alert to a mobile phone as an SMS from your Twilio
phone number. The SMS will contain the alert name. You may use either Twilio SMS
or Twilio Copilot to send the message, controlled by the ``twilio_use_copilot``
option.

Note that when twilio copilot *is* used the ``twilio_message_service_sid`` option is required. Likewise, when *not* using twilio copilot, the ``twilio_from_number`` option is required.
Note that when Twilio Copilot *is* used the ``twilio_message_service_sid``
option is required. Likewise, when *not* using Twilio Copilot, the
``twilio_from_number`` option is required.

The alerter requires the following options:

``twilio_account_sid``: This is sid of your twilio account.
``twilio_account_sid``: The SID of your Twilio account.

``twilio_auth_token``: Auth token assosiated with your twilio account.
``twilio_auth_token``: Auth token associated with your Twilio account.

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

Either one of
* ``twilio_from_number``: Your twilio phone number from which message will be sent.
* ``twilio_message_service_sid``: The SID of your twilio message service.
* ``twilio_from_number``: The Twilio phone number from which the alert will be sent.
* ``twilio_message_service_sid``: The SID of your Twilio message service.

Optional:

``twilio_use_copilot``: Whether or not to use twilio copilot, False by default.
``twilio_use_copilot``: Whether or not to use Twilio Copilot, False by default.

Example With Copilot usage::
Example with Copilot usage::

alert:
- "twilio"
@@ -2890,7 +2894,7 @@ Example With Copilot usage::
twilio_account_sid: "ABCDEFGHIJKLMNOPQRSTUVWXYZ01234567"
twilio_message_service_sid: "ABCDEFGHIJKLMNOPQRSTUVWXYZ01234567"

Example With SMS usage::
Example with SMS usage::

alert:
- "twilio"