github.com/teknogeek/dnscontrol/v2@v2.10.1-0.20200227202244-ae299b55ba42/docs/notifications.md (about)

     1  ---
     2  layout: default
     3  title: Notifications
     4  ---
     5  # Notifications
     6  
     7  DNSControl has build in support for notifications when changes are made. This allows you to post messages in team chat, or send emails when dns changes are made.
     8  
     9  Notifications are written in the [notifications package](https://github.com/StackExchange/dnscontrol/tree/master/pkg/notifications), and is a really simple interface to implement if you want to add
    10  new types or destinations.
    11  
    12  ## Configuration
    13  
    14  Notifications are set up in your credentials json file. They will use the `notifications` key to look for keys or configuration needed for various notification types.
    15  
    16  ```
    17    "r53": {
    18        ...
    19      },
    20    "gcloud": {
    21          ...
    22    } ,
    23    "notifications":{
    24        "bonfire_url": "https://chat.meta.stackexchange.com/feeds/rooms/123?key=xyz"
    25    }
    26  ```
    27  
    28  You also must run `dnscontrol preview` or `dnscontrol push` with the `-notify` flag to enable notification sending at all.
    29  
    30  ## Notification types
    31  
    32  ### Bonfire
    33  
    34  This is stack overflow's built in chat system. This is probably not useful for most people.
    35  
    36  Configure `bonfire_url` to be the full url including room and api key.
    37  
    38  ## Future work
    39  
    40  Yes, this seems pretty limited right now in what it can do. We didn't want to add a bunch of notification types if nobody was going to use them. The good news is, it should 
    41  be really simple to add more. We gladly welcome any PRs with new notification destinations. Some easy possibilities:
    42  
    43  - Email
    44  - Slack
    45  - Generic Webhooks
    46  
    47  Please update this documentation if you add anything.