| 1 | # yamllint disable rule:line-length |
| 2 | --- |
| 3 | - id: 'notify-messagebird' |
| 4 | meta: |
| 5 | name: 'MessageBird' |
| 6 | link: 'https://messagebird.com/' |
| 7 | categories: |
| 8 | - notify.agent |
| 9 | icon_filename: 'messagebird.svg' |
| 10 | keywords: |
| 11 | - MessageBird |
| 12 | overview: |
| 13 | notification_description: | |
| 14 | Send notifications to MessageBird 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 | - An access key under 'API ACCESS (REST)' (you will want a live key), you can read more [here](https://developers.messagebird.com/quickstarts/sms/test-credits-api-keys/). |
| 22 | - Access to the terminal where Netdata Agent is running |
| 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_MESSAGEBIRD' |
| 33 | default_value: 'YES' |
| 34 | description: "Set `SEND_MESSAGEBIRD` to YES" |
| 35 | required: true |
| 36 | - name: 'MESSAGEBIRD_ACCESS_KEY' |
| 37 | default_value: '' |
| 38 | description: "Set `MESSAGEBIRD_ACCESS_KEY` to your API key." |
| 39 | required: true |
| 40 | - name: 'MESSAGEBIRD_NUMBER' |
| 41 | default_value: '' |
| 42 | description: "Set `MESSAGEBIRD_NUMBER` to the MessageBird number you want to use for the alert." |
| 43 | required: true |
| 44 | - name: 'DEFAULT_RECIPIENT_MESSAGEBIRD' |
| 45 | default_value: '' |
| 46 | description: "Set `DEFAULT_RECIPIENT_MESSAGEBIRD` to the number you want the alert notification to be sent as an SMS. You can define multiple recipients like this: +15555555555 +17777777777." |
| 47 | required: true |
| 48 | detailed_description: | |
| 49 | All roles will default to this variable if left unconfigured. |
| 50 | |
| 51 | You can then have different recipients per role, by editing `DEFAULT_RECIPIENT_MESSAGEBIRD` with the number you want, in the following entries at the bottom of the same file: |
| 52 | ```text |
| 53 | role_recipients_messagebird[sysadmin]="+15555555555" |
| 54 | role_recipients_messagebird[domainadmin]="+15555555556" |
| 55 | role_recipients_messagebird[dba]="+15555555557" |
| 56 | role_recipients_messagebird[webmaster]="+15555555558" |
| 57 | role_recipients_messagebird[proxyadmin]="+15555555559" |
| 58 | role_recipients_messagebird[sitemgr]="+15555555550" |
| 59 | ``` |
| 60 | examples: |
| 61 | folding: |
| 62 | enabled: true |
| 63 | title: '' |
| 64 | list: |
| 65 | - name: 'Basic Configuration' |
| 66 | folding: |
| 67 | enabled: false |
| 68 | description: '' |
| 69 | config: | |
| 70 | #------------------------------------------------------------------------------ |
| 71 | # Messagebird (messagebird.com) SMS options |
| 72 | |
| 73 | SEND_MESSAGEBIRD="YES" |
| 74 | MESSAGEBIRD_ACCESS_KEY="XXXXXXXX" |
| 75 | MESSAGEBIRD_NUMBER="XXXXXXX" |
| 76 | DEFAULT_RECIPIENT_MESSAGEBIRD="+15555555555" |
| 77 | troubleshooting: |
| 78 | problems: |
| 79 | list: [] |