Notifications
Learn how to set Galaxy's notification to your account and apps.
Galaxy notifications are the best way to stay informed about your apps running on Galaxy. We support notifications via Slack and Email.
Notifications are sent when activity occurs in your account:
We recommend activating notifications for at least these types:
- Deploy failed
- Build failed temporarily
- Build failed permanently
- App automatically stopped
- Certificate generation error
In order for you to ensure minimal disruption, should critical issues occur.
It could also be important to enable these types below if your app can consume too much CPU or Memory, allowing you to receive notifications when this starts to affect your users. These activities also produce logs in the service tab but are not displayed in the timeline of activities:
- Container unhealthy
- App unavailable
Let's begin configuring your account settings. Go to your Galaxy dashboard and click on the Settings tab of your account. Below the section PLAN, you will see the section NOTIFICATIONS.
When you click on CHANGE, if your account was created before Notifications existed on Galaxy, everything will be disabled. If your account was created when Notifications were already on Galaxy, the email option will be enabled with some types of activities already checked.
Enabling email notifications is simple. You just need to click on ENABLE EMAIL NOTIFICATIONS and choose which types of activity you want to receive an email about, then click SAVE at the end of the section.
If you have an individual account, nothing more needs to be done. If you have an organization account, you'll have to set which members of your organization should receive the emails.
You can do this by going to your Galaxy dashboard and clicking on the MEMBERS tab. Below EMAIL NOTIFICATIONS you will see all members of your organization. If you just created the account, your card will be green, meaning you are already enabled to receive the emails by default. If you already have an account, all members will be disabled. To enable or disable a member just click on their card, then hit the save button.
Then you're good to go! All chosen members will receive the notifications by email.
First, you will need to add an Incoming WebHooks to a channel in your Slack. To do this, please go to this page.
Once you get your URL (that will be something like this: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX), go to your Galaxy dashboard. In the NOTIFICATION SETTINGS, click on ENABLE SLACK NOTIFICATIONS.
You can go ahead and paste your URL in the Slack Incoming WebHooks URL field. In the table below this field, you can choose which activities you want to receive notifications for, and you also can fill the Custom Slack Channel with a name of an existing channel that you have in your Slack account. With this, you can receive different activity notifications to different channels. If you don't fill this field, we will send the notification to the channel that you first used to install the Incoming WebHooks app in your Slack.
After setting everything up, just hit the save button!
The settings above will be applied to every app in your account. However, you can customize these settings for each app.
To do so, choose an app that you want to have custom notification settings, then go to settings. Below DOMAINS & ENCRYPTION you'll see NOTIFICATIONS. When you click on CHANGE, the button ENABLE CUSTOM APP NOTIFICATIONS will appear. When you click this button, the same options from your account's notification setting will be displayed. From now on, all notifications for this app will behave according to the app settings and not the account settings.
Now, for example, if you click on ENABLE CUSTOM APP NOTIFICATIONS, keeping the Email and Slack options disabled, and hit SAVE, you will be disabling the notifications for that app. This means you have control over the notifications on each app. Each application configuration is independent; you can customize everything at the app level!
The way to set up the Email and Slack option here is the same as from Account Settings.
Galaxy notifications are the best way to stay informed about your apps running on Galaxy. We support notifications via Slack and Email.
Activity Types
Notifications are sent when activity occurs in your account:
We recommend activating notifications for at least these types:
- Deploy failed
- Build failed temporarily
- Build failed permanently
- App automatically stopped
- Certificate generation error
In order for you to ensure minimal disruption, should critical issues occur.
It could also be important to enable these types below if your app can consume too much CPU or Memory, allowing you to receive notifications when this starts to affect your users. These activities also produce logs in the service tab but are not displayed in the timeline of activities:
- Container unhealthy
- App unavailable
Usage
Account Settings
Let's begin configuring your account settings. Go to your Galaxy dashboard and click on the Settings tab of your account. Below the section PLAN, you will see the section NOTIFICATIONS.
When you click on CHANGE, if your account was created before Notifications existed on Galaxy, everything will be disabled. If your account was created when Notifications were already on Galaxy, the email option will be enabled with some types of activities already checked.
Email Settings
Enabling email notifications is simple. You just need to click on ENABLE EMAIL NOTIFICATIONS and choose which types of activity you want to receive an email about, then click SAVE at the end of the section.
If you have an individual account, nothing more needs to be done. If you have an organization account, you'll have to set which members of your organization should receive the emails.
You can do this by going to your Galaxy dashboard and clicking on the MEMBERS tab. Below EMAIL NOTIFICATIONS you will see all members of your organization. If you just created the account, your card will be green, meaning you are already enabled to receive the emails by default. If you already have an account, all members will be disabled. To enable or disable a member just click on their card, then hit the save button.
Then you're good to go! All chosen members will receive the notifications by email.
Slack Settings
First, you will need to add an Incoming WebHooks to a channel in your Slack. To do this, please go to this page.
Once you get your URL (that will be something like this: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX), go to your Galaxy dashboard. In the NOTIFICATION SETTINGS, click on ENABLE SLACK NOTIFICATIONS.
You can go ahead and paste your URL in the Slack Incoming WebHooks URL field. In the table below this field, you can choose which activities you want to receive notifications for, and you also can fill the Custom Slack Channel with a name of an existing channel that you have in your Slack account. With this, you can receive different activity notifications to different channels. If you don't fill this field, we will send the notification to the channel that you first used to install the Incoming WebHooks app in your Slack.
After setting everything up, just hit the save button!
App Settings
The settings above will be applied to every app in your account. However, you can customize these settings for each app.
To do so, choose an app that you want to have custom notification settings, then go to settings. Below DOMAINS & ENCRYPTION you'll see NOTIFICATIONS. When you click on CHANGE, the button ENABLE CUSTOM APP NOTIFICATIONS will appear. When you click this button, the same options from your account's notification setting will be displayed. From now on, all notifications for this app will behave according to the app settings and not the account settings.
Now, for example, if you click on ENABLE CUSTOM APP NOTIFICATIONS, keeping the Email and Slack options disabled, and hit SAVE, you will be disabling the notifications for that app. This means you have control over the notifications on each app. Each application configuration is independent; you can customize everything at the app level!
The way to set up the Email and Slack option here is the same as from Account Settings.
Updated on: 15/07/2024
Thank you!