License requirements:
To use the Notifications feature, your Gearset team must be on the Deployment Teams or Enterprise license.
For more information on our pricing tiers, you can check the Pricing page.
FYI: This specific feature isn't available for CI jobs, but check our documentation on options for managing notifications on your CI jobs.
How to access Notifications in Gearset
Notifications allow users to choose which team members will receive an email when a deployment is made via Compare and deploy to specific connections (target environments) - and these connections can be configured on the account Notifications page:
Target connection can be a Salesforce org (standalone or a team-shared org connection), or your Version Control System (e.g. a specific Git branch).
Any settings that you have previously configured (prior to Gearset releasing the Notifications feature) will appear under All my other connections option.
How can this feature help my team?
If you're interested in having more flexibility and granularity (as well as transparency across your Gearset team) around configuring notifications for deployments and validations made via Compare and deploy, then setting up notifications for team members other than the user (e.g. yourself) executing a deployment is a useful step forward.
We offer you an ability to notify team members for any deployments made via Compare and deploy - which means these notifications do not apply for CI job deployments!
How to set up notifications for CI jobs used in Pipelines?
If you're interested in configuring notifications for CI jobs that are a part of your Gearset Pipeline, you'd need to follow this documentation for guidelines:
Setting up notifications in pipelines
How to set up a notification for 'Compare and deploy' deployments
To add a new notifications for a specific deployment connection, on your Notifications page select +Add notification.
You'll see below Add notification rule pop up window:
Under "Connection type" you can choose from these three options:
Salesforce connection (an org)
Source control (VCS provider e.g. GitHub, Azure DevOps etc)
All my other connections
Under "Select connection" you're likely to choose either a Salesforce org, or a Version Control System that is already connected to your Gearset account.
On below example, we've selected a Test1 org:
Next, decide when a notification is to be sent to another team member.
You have three options: when the deployment Succeeds or fails, when it Succeeds, or only when it Fails.
Next, you can look up team members on your team to whom you want email notifications to be sent.
Once added to the list, the names of team members will show up as on image below.
Can I set up email notifications to custom email addresses?
Unfortunately, this is not possible. Read more about why here.
Note: We have two other helpful resources with information on how to add Gearset notifications to Slack or MS Teams channels.
Once you've configured everything, select Save.
You also have options to add Slack and/or MS Teams integration URLs.
When your notification is set up, it will be shown in the My connections / Team-shared connections tab - depending on whether you've set up a notification for an individual ora a team-shared org or VCS connection.
The notification we've added shows in My connections because it's been set up for an individual org:
By selecting this option (three parenthesis):
you also get access to either Edit or Delete your existing notification.
On the above screenshot, you see examples of other notifications apart from the notification we've gone through adding as part of this article.
For example, there is an email notification only for failed deployments to GitHub branches. We also have a notification for either successful or failed deployments to BitBucket branches.
Important to note: When you add a notification for a specific Version Control System (e.g. GitHub), the team members you selected will receive email notifications for every deployment made to any Git branch within that VCS.
At present, there are no granular restrictions that can be made to limit this functionality (e.g. if you only wanted team members to receive notifications after a commit to a specific branch within the repository).
FAQs
Is it possible to set up email notifications for custom email addresses?
Is it possible to set up email notifications for custom email addresses?
No, adding custom email addresses for your Compare and deploy notifications is not possible. Our app allows you to set up notifications only for existing Gearset team members.
If you have set up notifications for custom email addresses before 15 April 2025 (so prior to the new UI release), Gearset will continue sending these notifications. However, past that date once you remove a custom email from your notifications it won't be possible to re-add it.
What's the alternative?
The alternative is to use Slack or Teams notifications if you intend to notify other people than your Gearset team members about any of the deployments.
What if I don't want to use Slack or Teams notifications?
You can set up a service user Gearset account under the email address for which you'd like to receive deployment/validation notifications (e.g. this could be a common inbox available for all of your team members), and configure email notifications to be sent to that Gearset user.
Is it possible to set up notifications for orgs delegated to me?
Is it possible to set up notifications for orgs delegated to me?
If you have an org that has been delegated to you by another member on your Gearset team, consider that it may not be possible for you to add an email notification for that specific org.
As a workaround, we recommend that the member who delegated the org connection to you configures such notification directly on their Gearset account.