Skip to main content
All CollectionsTeam managementAccount and user management
Email notifications - for deployments made via Compare and deploy
Email notifications - for deployments made via Compare and deploy

Guidance on how to configure email notifications sent to your team members for 'Compare and deploy' deployments

Mateusz Kochanowicz avatar
Written by Mateusz Kochanowicz
Updated over 3 months ago

Note: To use the Notifications feature, your Gearset team must be on the Deployment Teams license tier, or higher (such as an 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.

Notifications feature allows users to choose which team members will also receive an email when a deployment is performed using Compare and deploy to specific connections (target environments) - and these connections can configured on the account Notifications page:

Target connection can be a Salesforce org (individual org or a team-shared one), or your Version Control System (a 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 manual deployments and validations, then setting up notifications for other team members than the person (team member) executing a deployment is a useful step forward.

We offer you an ability to notify team members on manual deployments (which means this feature doesn't support automated CI jobs) to specific Salesforce org or Version Control System connections.

For example, you may want to notify another team member about all of your deployments to UAT org.

How to set up a notification for 'Compare and deploy' deployment?

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 the drop down either: Salesforce connection, Source control or All my other connections.

Under Select connection choose either a Salesforce org, or a Version Control System 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, Succeeds, or 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.

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 dots):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.

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).

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).

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.

Did this answer your question?