| 1 | # yamllint disable rule:line-length |
| 2 | --- |
| 3 | - id: 'notify-twilio' |
| 4 | meta: |
| 5 | name: 'Twilio' |
| 6 | link: 'https://www.twilio.com/' |
| 7 | categories: |
| 8 | - notify.agent |
| 9 | icon_filename: 'twilio.png' |
| 10 | keywords: |
| 11 | - Twilio |
| 12 | overview: |
| 13 | notification_description: | |
| 14 | Send notifications to Twilio using Netdata's Agent alert notification feature, which supports dozens of endpoints, user roles, and more. |
| 15 | notification_limitations: '' |
| 16 | setup: |
| 17 | prerequisites: |
| 18 | list: |
| 19 | - title: '' |
| 20 | description: | |
| 21 | - Get your SID, and Token from https://www.twilio.com/console |
| 22 | - Terminal access to the Agent you wish to configure |
| 23 | configuration: |
| 24 | file: |
| 25 | name: 'health_alarm_notify.conf' |
| 26 | options: |
| 27 | description: 'The following options can be defined for this notification' |
| 28 | folding: |
| 29 | title: 'Config Options' |
| 30 | enabled: true |
| 31 | list: |
| 32 | - name: 'SEND_TWILIO' |
| 33 | default_value: 'YES' |
| 34 | description: "Set `SEND_TWILIO` to YES" |
| 35 | required: true |
| 36 | - name: 'TWILIO_ACCOUNT_SID' |
| 37 | default_value: '' |
| 38 | description: "set `TWILIO_ACCOUNT_SID` to your account SID." |
| 39 | required: true |
| 40 | - name: 'TWILIO_ACCOUNT_TOKEN ' |
| 41 | default_value: '' |
| 42 | description: "Set `TWILIO_ACCOUNT_TOKEN` to your account token." |
| 43 | required: true |
| 44 | - name: 'TWILIO_NUMBER' |
| 45 | default_value: '' |
| 46 | description: "Set `TWILIO_NUMBER` to your account's number." |
| 47 | required: true |
| 48 | - name: 'DEFAULT_RECIPIENT_TWILIO' |
| 49 | default_value: '' |
| 50 | description: "Set DEFAULT_RECIPIENT_TWILIO to the number you want the alert notifications to be sent to. You can define multiple numbers like this: +15555555555 +17777777777." |
| 51 | required: true |
| 52 | detailed_description: | |
| 53 | You can then have different recipients per role, by editing DEFAULT_RECIPIENT_TWILIO with the recipient's number you want, in the following entries at the bottom of the same file: |
| 54 | |
| 55 | ```text |
| 56 | role_recipients_twilio[sysadmin]="+15555555555" |
| 57 | role_recipients_twilio[domainadmin]="+15555555556" |
| 58 | role_recipients_twilio[dba]="+15555555557" |
| 59 | role_recipients_twilio[webmaster]="+15555555558" |
| 60 | role_recipients_twilio[proxyadmin]="+15555555559" |
| 61 | role_recipients_twilio[sitemgr]="+15555555550" |
| 62 | ``` |
| 63 | examples: |
| 64 | folding: |
| 65 | enabled: true |
| 66 | title: '' |
| 67 | list: |
| 68 | - name: 'Basic Configuration' |
| 69 | folding: |
| 70 | enabled: false |
| 71 | description: '' |
| 72 | config: | |
| 73 | #------------------------------------------------------------------------------ |
| 74 | # Twilio (twilio.com) SMS options |
| 75 | |
| 76 | SEND_TWILIO="YES" |
| 77 | TWILIO_ACCOUNT_SID="xxxxxxxxx" |
| 78 | TWILIO_ACCOUNT_TOKEN="xxxxxxxxxx" |
| 79 | TWILIO_NUMBER="xxxxxxxxxxx" |
| 80 | DEFAULT_RECIPIENT_TWILIO="+15555555555" |
| 81 | troubleshooting: |
| 82 | problems: |
| 83 | list: [] |