# Notification Settings
Setting up ways for you to receive your notifications is explained in Notification Channels, but for configuring those notifications, you can look at the following endpoints.
From Data Masking and Summary Emails, to Alerting on Console Changes and Alerting on Device Changes, you'll be able to manage them all through these endpoints.
# Change Alerts
Unexpected changes to Bird or Console settings can be a sign that someone is playing around where they shouldn't be. We allow for you to enable alerting in these cases, letting you know as soon as someone makes a change.
# Disable Console Settings Change Alerts
POST /api/v1/settings/console_settings_change/disable
Disable Console settings change alerts.
Required Parameters
Response
A JSON structure with result indicator.
Example
{
"result": "success"
}
2
3
# Enable Console Settings Change Alerts
POST /api/v1/settings/console_settings_change/enable
Enable Console settings change alerts.
Required Parameters
Response
A JSON structure with result indicator.
Example
{
"result": "success"
}
2
3
# Disable Device Settings Change Alerts
POST /api/v1/settings/device_settings_change/disable
Disable Device settings change alerts.
Required Parameters
Response
A JSON structure with result indicator.
Example
{
"result": "success"
}
2
3
# Enable Device Settings Change Alerts
POST /api/v1/settings/device_settings_change/enable
Enable Device settings change alerts.
Required Parameters
Response
A JSON structure with result indicator.
Example
{
"result": "success"
}
2
3
# Data Masking
When we create alerts, they will include sensitive information such as the credentials used. Now, we think that having this information is good as you'll want to change those creds in any case, but we do give you the ability to mask this information in the alert details.
# Disable Data Masking
POST /api/v1/settings/notifications/masking/disable
Disable masking of details in alert notifications.
Required Parameters
Response
A JSON structure with result indicator.
Example
{
"result": "success"
}
2
3
# Enable Data Masking
POST /api/v1/settings/notifications/masking/enable
Enable masking of details in alert notifications.
Required Parameters
Response
A JSON structure with result indicator.
Example
{
"result": "success"
}
2
3
# Summary Emails
If you want, we can send a weekly summary of your Console activity every Monday. Along with that, we'll include any Canary related news that we deem useful (this usually includes a couple of worthy news items).
The endpoints on this page are for configuring summary email delivery to email addresses that are not registered Console users.
To enable or disable summary emails for a registered Console user, use the /api/v1/user/summary_email/enable and /api/v1/user/summary_email/disable endpoints documented on the Users Management page.
To configure summary emails for non-user recipient addresses, enable summary emails and set a list of email addresses.
# Disable Summary Emails
POST /api/v1/settings/notifications/summary_email/disable
Disable weekly summary emails for your Console.
Required Parameters
Response
A JSON structure with result indicator.
Example
{
"result": "success"
}
2
3
# Enable Summary Emails
POST /api/v1/settings/notifications/summary_email/enable
Enable weekly summary emails for your Console.
Required Parameters
Response
A JSON structure with result indicator.
Example
{
"result": "success"
}
2
3
# Set Summary Emails
POST /api/v1/settings/notifications/summary_email/save
Set the list of email addresses that will receive the weekly summary emails.
Required Parameters
Optional Parameters
TIP
At least one of the optional parameters is required.
Response
A JSON structure with result indicator.
Example
{
"emails": "<email_address>,<email_address>",
"result": "success"
}
2
3
4