| 1 | # yamllint disable rule:line-length |
| 2 | --- |
| 3 | - id: 'notify-pushbullet' |
| 4 | meta: |
| 5 | name: 'Pushbullet' |
| 6 | link: 'https://www.pushbullet.com/' |
| 7 | categories: |
| 8 | - notify.agent |
| 9 | icon_filename: 'pushbullet.png' |
| 10 | keywords: |
| 11 | - Pushbullet |
| 12 | overview: |
| 13 | notification_description: | |
| 14 | Send notifications to Pushbullet 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 | - A Pushbullet access token that can be created in your [account settings](https://www.pushbullet.com/#settings/account). |
| 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_PUSHBULLET' |
| 33 | default_value: 'YES' |
| 34 | description: "Set `Send_PUSHBULLET` to YES" |
| 35 | required: true |
| 36 | - name: 'PUSHBULLET_ACCESS_TOKEN' |
| 37 | default_value: '' |
| 38 | description: "set `PUSHBULLET_ACCESS_TOKEN` to the access token you generated." |
| 39 | required: true |
| 40 | - name: 'DEFAULT_RECIPIENT_PUSHBULLET' |
| 41 | default_value: '' |
| 42 | description: "Set `DEFAULT_RECIPIENT_PUSHBULLET` to the email (e.g. `example@domain.com`) or the channel tag (e.g. `#channel`) you want the alert notifications to be sent to." |
| 43 | required: true |
| 44 | detailed_description: | |
| 45 | You can define multiple entries like this: user1@email.com user2@email.com. |
| 46 | |
| 47 | All roles will default to this variable if left unconfigured. |
| 48 | |
| 49 | The `DEFAULT_RECIPIENT_PUSHBULLET` can be edited in the following entries at the bottom of the same file: |
| 50 | ```text |
| 51 | role_recipients_pushbullet[sysadmin]="user1@email.com" |
| 52 | role_recipients_pushbullet[domainadmin]="user2@mail.com" |
| 53 | role_recipients_pushbullet[dba]="#channel1" |
| 54 | role_recipients_pushbullet[webmaster]="#channel2" |
| 55 | role_recipients_pushbullet[proxyadmin]="user3@mail.com" |
| 56 | role_recipients_pushbullet[sitemgr]="user4@mail.com" |
| 57 | ``` |
| 58 | examples: |
| 59 | folding: |
| 60 | enabled: true |
| 61 | title: '' |
| 62 | list: |
| 63 | - name: 'Basic Configuration' |
| 64 | folding: |
| 65 | enabled: false |
| 66 | description: '' |
| 67 | config: | |
| 68 | #------------------------------------------------------------------------------ |
| 69 | # pushbullet (pushbullet.com) push notification options |
| 70 | |
| 71 | SEND_PUSHBULLET="YES" |
| 72 | PUSHBULLET_ACCESS_TOKEN="XXXXXXXXX" |
| 73 | DEFAULT_RECIPIENT_PUSHBULLET="admin1@example.com admin3@somemail.com #examplechanneltag #anotherchanneltag" |
| 74 | troubleshooting: |
| 75 | problems: |
| 76 | list: [] |