doc/user/profile/notifications.md
{{< details >}}
{{< /details >}}
{{< history >}}
enhanced_notify_css. Disabled by default.enhanced_notify_css removed.{{< /history >}}
Stay informed about what's happening in GitLab with email notifications. You can receive updates about activity in issues, merge requests, epics, and designs.
For the tool that GitLab administrators can use to send messages to users, read Email from GitLab.
In GitLab 17.2 and later, notifications are rate limited per 24 hours per project or group per user.
When notifications are enabled for an issue, merge request, or epic, GitLab notifies you of actions that happen there.
You might receive notifications for one of the following reasons:
GitLab does not send a notification when:
Your global notification settings are the default settings, unless you specify different settings for a project or a group. For example, you might want to be notified about all activity in a specific project. For other projects, you only want to be notified when you are mentioned by name.
These notification settings apply only to you. They do not affect the notifications received by anyone else.
To edit your notification settings:
To the right of each project and group you can select a notification level:
| Level | Description |
|---|---|
| Global | Your default global settings apply. |
| Watch | Receive notifications for most activity. |
| Participate | Receive notifications for threads you have participated in. |
| On mention | Receive notifications when you are mentioned in a comment. |
| Disabled | Receive no notifications. |
| Custom | Same as Participate, plus any additional notification events you select. |
You can tune the scope of your notifications by selecting different notification levels for each project and group.
Notification scope is applied from the broadest to most specific levels:
When you set the notification level to Global for a project or subgroup, it does not directly inherit your global notification settings. Instead, it goes up the hierarchy and inherits the next non-global notification level that is configured, in the following order:
For example, you set your default global notification setting to Watch, and your group and project notification levels as follows:
%%{init: { "fontFamily": "GitLab Sans", 'theme':'neutral' }}%%
flowchart TD
accTitle: Notification hierarchy
accDescr: Example of a group, subgroup, and project
N[Default/global notification level set to Watch]
N --> A
A[Group A: Notification level set to Global]
A-. Inherits Watch level .-> N
A --> B[Subgroup B: Notification level set to Participate]
B --> C[Project C: Notification level set to Global]
C-. Inherits Participate level .-> B
Project C inherits the Participate notification level from subgroup B. It does not inherit the Watch notification level from your global notification settings.
You can select a notification level and email address for each group.
To select a notification level for a group, use either of these methods:
Or:
You can select an email address to receive notifications for each group you belong to. You can use group notifications, for example, if you work freelance, and want to keep email about clients' projects separate.
To help you stay up to date, you can select a notification level for each project.
To select a notification level for a project, use either of these methods:
Or:
<i class="fa-youtube-play" aria-hidden="true"></i> To learn how to be notified when a new release is available, watch Notification for releases.
Notifications are sent for user, project, or group events, and for activity on work items.
{{< history >}}
{{< /history >}}
User notification events:
| Event | Sent to | Details |
|---|---|---|
| Email changed | User | Security email, always sent. |
| Group access level changed | User | |
| New email address added | User | Security email, sent to newly-added email address. |
| New email address added | User | Security email, sent to primary email address. |
| New SSH key added | User | Security email, always sent. |
| New user created | User | Sent on user creation, except for OmniAuth (LDAP). |
| Password changed | User | Security email, always sent when user changes their own password. |
| Password changed by administrator | User | Security email, always sent when an administrator changes the password of another user. |
| Personal access token has been revoked | User | Security email, always sent. |
| Personal access token has been rotated | User | Security email, always sent. |
| Personal access tokens expiring soon | User | Security email, always sent. |
| Personal access tokens have been created | User | Security email, always sent. |
| Personal access tokens have expired | User | Security email, always sent. |
| SSH key has expired | User | Security email, always sent. |
| Two-factor authentication disabled | User | Security email, always sent. |
{{< history >}}
{{< /history >}}
Project notification events:
| Event | Sent to | Details |
|---|---|---|
| New release | Project members | Only sent when the Release is created custom notification level is selected. |
| Project access expired | Project members | Sent when user's access to a project expires in seven days. |
| Project access level changed | Project members | Sent when user project access level is changed. |
| Project access tokens expiring soon | Direct project Owners and Maintainers | Security email, always sent. |
| Project deploy tokens expiring soon | Project Owners and Maintainers | Security email, always sent. |
| Project moved | Project members | Sent for all notification levels except disabled, or when the Project is moved custom notification level is selected. |
| Project scheduled for deletion | Project Owners | Sent when project is scheduled for deletion. |
| User added to project | User | Sent when user is added to project. |
{{< history >}}
{{< /history >}}
Group notification events:
| Event | Sent to | Details |
|---|---|---|
| Group access expired | Group members | Sent when user's access to a group expires in seven days. |
| Group access tokens expiring soon | Direct Group Owners | Security email, always sent. |
| Group scheduled for deletion | Group Owners | Sent when group is scheduled for deletion. |
| User added to group | User | Sent when user is added to group. |
| New SAML/SCIM user provisioned | User | Sent when a user is provisioned through SAML/SCIM. |
{{< history >}}
{{< /history >}}
Events generate notifications based on the notification level selected. Some notifications can be optionally enabled by selecting the Custom notification level, and selecting the desired events. You can also manually subscribe to notifications for and epic, issue, or merge request.
By default, you don't receive notifications for issues, merge requests, or epics you create. You can turn on notifications about your own activity.
Epic event notifications are sent for the following notification levels:
| Event | Watch | Participate | On Mention | Subscribed | Custom | Additional details |
|---|---|---|---|---|---|---|
| Closed | Yes | Yes | Yes | Yes | ||
| New epic | Yes | Yes | Yes | Yes | Sent when someone is mentioned by username in the description. | |
| New comment | Yes | Yes | Yes | Yes | If Comment is added is selected | Also sent when someone is mentioned by username in the comment. |
| Reopened | Yes | Yes | Yes | Yes |
Issue event notifications are sent for the following notification levels:
| Event | Watch | Participate | On Mention | Subscribed | Custom | Additional details |
|---|---|---|---|---|---|---|
| Closed | Yes | Yes | Yes | If Issue is closed is selected | ||
| Due tomorrow | Yes | If Issue is due tomorrow is selected | The notification is sent at 00:50 in the server's time zone (UTC for GitLab.com) for open issues with a due date of the next calendar day. | |||
| Milestone changed | Yes | Yes | Yes | Yes | ||
| Milestone removed | Yes | Yes | Yes | Yes | ||
| New issue | Yes | Yes | Yes | If Issue is created is selected | Also sent when someone is mentioned by username in the description. | |
| New comment | Yes | Yes | Yes | Yes | If Comment is added is selected | Also sent when someone is mentioned by username in the comment. |
| Title or description changed | Yes | Yes | Any new mentions by username. | |||
| Reassigned | Yes | Yes | Yes | If Issue is reassigned is selected | Also sent to the previous assignee. | |
| Reopened | Yes | Yes | Yes | If Issue is reopened is selected |
Merge request notifications are sent for the following notification levels:
| Event | Watch | Participate | On Mention | Subscribed | Custom | Additional details |
|---|---|---|---|---|---|---|
| Closed | Yes | Yes | Yes | If Merge request is closed is selected | ||
| Conflict | Yes | Author and any user that has set the merge request to auto-merge. | ||||
| Marked as ready | Yes | Yes | Yes | |||
| Merged | Yes | Yes | Yes | If Merge request is merged is selected | ||
| Set to auto-merge | Yes | Yes | Yes | If Merge request is set to auto-merge is selected | Custom notification level is ignored for author, watcher, and subscribers. | |
| Milestone changed | Yes | Yes | Yes | Yes | ||
| Milestone removed | Yes | Yes | Yes | Yes | ||
| New merge request | Yes | Yes | Yes | If Merge request is created is selected | Anyone mentioned by username in the description. | |
| New comment | Yes | Yes | Yes | Yes | If Comment is added is selected | Anyone mentioned by username in the comment. |
| New push | Yes | If Merge request receives a push is selected | ||||
| Reassigned | Yes | Yes | Yes | If Merge request is reassigned is selected | Also sent to the previous assignee. | |
| Reviewers are changed | Yes | Yes | Yes | If Merge request reviewers are changed is selected | Also sent to the previous reviewer. | |
| Reopened | Yes | Yes | Yes | If Merge request is reopened is selected | ||
| Title or description changed | Yes | Yes | Any new mentions by username. | |||
| New merge request you're eligible to approve. | If Merge request you're eligible to approve is created is selected |
To toggle notifications on a specific issue, merge request, or epic:
{{< details >}}
{{< /details >}}
{{< history >}}
notifications_todos_buttons. Disabled by default.{{< /history >}}
[!flag] The availability of this feature is controlled by a feature flag. For more information, see the history. Enabling this feature flag moves the notifications and to-do item buttons to the upper-right corner of the page.
When you turn on notifications, you start receiving notifications on each update, even if you haven't participated in the discussion. When you turn notifications on in an epic, you aren't automatically subscribed to the issues linked to the epic.
When you turn off notifications, you stop receiving notifications for updates. Turning this toggle off only unsubscribes you from updates related to this issue, merge request, or epic. Learn how to opt out of all emails from GitLab.
CI/CD pipeline event notifications are sent to the pipeline creator for the following notification levels:
| Event | Watch | Custom | Additional Details |
|---|---|---|---|
| Failed | Yes | If Pipeline fails is selected | |
| Fixed | If Pipeline is fixed is selected | ||
| Successful | Yes | If Pipeline is successful is selected | If the pipeline failed previously, a "Fixed pipeline" message is sent for the first successful pipeline after the failure, and then a "Successful pipeline" message for any further successful pipelines. |
Service account pipeline event notifications are sent for the following notification levels:
| Event | Watch | Custom |
|---|---|---|
| Failed | Yes | If Pipeline by Service Account fails is selected |
| Fixed | If Pipeline by Service Account is fixed is selected | |
| Successful | Yes | If Pipeline by Service Account is successful is selected |
Issue 501083 tracks adding all events to the Watch level.
To disable always sent security emails on GitLab Self-Managed and GitLab Dedicated,
an instance administrator can disable individual background jobs.
For example:
personal_access_tokens_expiring_workerpersonal_access_tokens_expired_notification_workerssh_keys_expiring_soon_notification_workerssh_keys_expired_notification_workersend_recurring_notifications_workerdeploy_tokens_expiring_workermembers_expiring_worker{{< history >}}
{{< /history >}}
[!note] This feature is enabled by default for GitLab Self-Managed instances. Administrators may disable this feature through the Sign-in restrictions section of the UI. The feature is always enabled on GitLab.com.
When a user successfully signs in from a previously unknown IP address or device, GitLab notifies the user by email. In this way, GitLab proactively alerts users of potentially malicious or unauthorized sign-ins. This notification email includes the:
GitLab uses several methods to identify a known sign-in. All methods must fail for a notification email to be sent.
{{< history >}}
{{< /history >}}
GitLab sends you an email notification if it detects an attempt to sign in to your account using a wrong two-factor authentication (2FA) code. This can help you detect that a bad actor gained access to your username and password, and is trying to brute force 2FA.
Email notifications are sent to the participants when someone comments on a design.
The participants are:
{{< history >}}
{{< /history >}}
GitLab sends an email notification if a user's access to a group or project expires in seven days. This reminds group or project members to extend their access duration if they want to.
If you no longer wish to receive any email notifications:
On GitLab Self-Managed and Dedicated instances, even after doing this, certain event notifications are still sent:
always sentYou can unsubscribe from notification emails from GitLab on a per-resource basis (for example a specific issue).
Every notification email from GitLab contains an unsubscribe link at the bottom.
To unsubscribe:
Your email client might show an Unsubscribe button when you view an email from GitLab. To unsubscribe, select this button.
Notification emails from GitLab contain special headers. These headers allow supported email clients and other software to unsubscribe users automatically. Here's an example:
List-Unsubscribe: <https://gitlab.com/-/sent_notifications/[REDACTED]/unsubscribe>,<mailto:incoming+[REDACTED][email protected]>
List-Unsubscribe-Post: List-Unsubscribe=One-Click
The List-Unsubscribe header has two entries:
POST request.
This action directly unsubscribes the user from the resource.
Sending a GET request to this link shows a confirmation dialog instead of unsubscribing.Unsubscribing by email is subject to the same two year retention policy as replying by email.
Notification email messages include GitLab-specific headers. To better manage your notifications, you can filter the notification emails based on the content of these headers.
For example, you could filter all emails from a specific project where you are being assigned a merge request or an issue.
The following table lists all GitLab-specific email headers:
| Header | Description |
|---|---|
List-Id | The path of the project in an RFC 2919 mailing list identifier. You can use it for email organization with filters. |
X-GitLab-(Resource)-ID | The ID of the resource the notification is for. The resource, for example, can be Issue, MergeRequest, Commit, or another such resource. |
X-GitLab-(Resource)-State | The state of the resource the notification is for. The resource can be, for example, Issue or MergeRequest. The value can be opened, closed, merged, or locked. Introduced in GitLab 16.4. |
X-GitLab-ConfidentialIssue | The boolean value indicating issue confidentiality for notifications. Introduced in GitLab 16.0. |
X-GitLab-Discussion-ID | The ID of the thread the comment belongs to, in notification emails for comments. |
X-GitLab-Group-Id | The group's ID. Only present on notification emails for epics. |
X-GitLab-Group-Path | The group's path. Only present on notification emails for epics. |
X-GitLab-NotificationReason | The reason for the notification. See possible values. |
X-GitLab-Pipeline-Id | The ID of the pipeline the notification is for, in notification emails for pipelines. |
X-GitLab-Project-Id | The project's ID. |
X-GitLab-Project-Path | The project's path. |
X-GitLab-Project | The name of the project the notification belongs to. |
X-GitLab-Group-Id | The group's ID. |
X-GitLab-Group-Path | The group's path. |
X-GitLab-Group | The name of the group the notification belongs to. |
X-GitLab-Reply-Key | A unique token to support reply by email. |
The X-GitLab-NotificationReason header contains the reason for the notification.
The value is one of the following, in order of priority:
own_activityassignedreview_requestedmentionedsubscribedThe reason for the notification is also included in the footer of the notification email.
For example, an email with the reason assigned has this sentence in the footer:
You are receiving this email because you have been assigned an item on <configured GitLab hostname>.
{{< details >}}
{{< /details >}}
An on-call alert notification email can have one of the alert's statuses:
alert_triggeredalert_acknowledgedalert_resolvedalert_ignored{{< details >}}
{{< /details >}}
An incident escalation notification email can have one of the incident's status:
incident_triggeredincident_acknowledgedincident_resolvedincident_ignoredExpanding the list of events included in the X-GitLab-NotificationReason header is tracked in
issue 20689.
If you want to pull a list of recipients to receive notifications from a project
(mainly used for troubleshooting custom notifications),
in a Rails console, run sudo gitlab-rails c and be sure to update the project name:
project = Project.find_by_full_path '<project_name>'
merge_request = project.merge_requests.find_by(iid: 1)
current_user = User.first
recipients = NotificationRecipients::BuildService.build_recipients(merge_request, current_user, action: "push_to"); recipients.count
recipients.each { |notify| puts notify.user.username }
If you receive notifications (through email or Slack) regarding a failed pipeline that no longer exists, double-check to see if you have any duplicate GitLab instances that could have triggered the message.
If you've enabled email notifications in GitLab, but users aren't receiving notifications as expected, ensure that your email is verified in GitLab and that your email provider isn't blocking emails from your GitLab instance. Many email providers (like Outlook) block emails coming from lesser-known self-managed mail server IP addresses. To verify, attempt to send an email directly from the SMTP server for your instance. For example, a test email from Sendmail might look something like:
# (echo subject: test; echo) | $(which sendmail) -v -Am -i <valid email address>
If your email provider is blocking the message, you might get output like the following (depending on your email provider and SMTP server):
Diagnostic-Code: smtp; 550 5.7.1 Unfortunately, messages from [xx.xx.xx.xx]
weren't sent. For more information, please go to
http://go.microsoft.com/fwlink/?LinkID=526655 (http://go.microsoft.com/fwlink/?LinkID=526655) AS(900)
Usually this issue can be resolved by adding the IP address of your SMTP server to your mail provider's allowlist. Check your mail provider's documentation for instructions.