notifications.md 8.57 KB
Newer Older
Karen's avatar
Karen committed
1
# GitLab Notification Emails
2

Karen's avatar
Karen committed
3
GitLab has a notification system in place to notify a user of events that are important for the workflow.
4 5 6

## Notification settings

7
You can find notification settings under the user profile.
8

9
![notification settings](img/notification_global_settings.png)
10

11
Notification settings are divided into three groups:
12

13 14 15
- Global settings
- Group settings
- Project settings
16 17 18

Each of these settings have levels of notification:

19
- Global: For groups and projects, notifications as per global settings.
20 21
- Watch: Receive notifications for any activity.
- Participate: Receive notifications for threads you have participated in.
22
- On Mention: Receive notifications when `@mentioned` in comments.
23 24
- Disabled: Turns off notifications.
- Custom: Receive notifications for custom selected events.
25

26
> Introduced in GitLab 12.0
27 28

You can also select an email address to receive notifications for each group you belong to.
29

30
### Global Settings
31

32
Global settings are at the bottom of the hierarchy.
33
Any setting set here will be overridden by a setting at the group or a project level.
34 35

Group or Project settings can use `global` notification setting which will then use
36 37
anything that is set at Global Settings.

38
### Group Settings
39

40 41
![notification settings](img/notification_group_settings.png)

42
Group settings are taking precedence over Global Settings but are on a level below Project or Subgroup settings:
43 44 45 46 47

```
Group < Subgroup < Project
```

48
This means that you can set a different level of notifications per group while still being able
49
to have a finer level setting per project or subgroup.
50 51
Organization like this is suitable for users that belong to different groups but don't have the
same need for being notified for every group they are member of.
52
These settings can be configured on group page under the name of the group. It will be the dropdown with the bell icon. They can also be configured on the user profile notifications dropdown.
53

54
### Project Settings
55

56 57
![notification settings](img/notification_project_settings.png)

58
Project settings are at the top level and any setting placed at this level will take precedence of any
59 60
other setting.
This is suitable for users that have different needs for notifications per project basis.
61
These settings can be configured on project page under the name of the project. It will be the dropdown with the bell icon. They can also be configured on the user profile notifications dropdown.
62 63 64 65 66

## Notification events

Below is the table of events users can be notified of:

67 68 69 70 71 72 73 74 75 76 77 78
| Event                        | Sent to             | Settings level               |
|------------------------------|---------------------|------------------------------|
| New SSH key added            | User                | Security email, always sent. |
| New email added              | User                | Security email, always sent. |
| Email changed                | User                | Security email, always sent. |
| Password changed             | User                | Security email, always sent. |
| New user created             | User                | Sent on user creation, except for omniauth (LDAP)|
| User added to project        | User                | Sent when user is added to project |
| Project access level changed | User                | Sent when user project access level is changed |
| User added to group          | User                | Sent when user is added to group |
| Group access level changed   | User                | Sent when user group access level is changed |
| Project moved                | Project members (1) | (1) not disabled |
Karen's avatar
Karen committed
79

80
### Issue / Epics / Merge request events
Douwe Maan's avatar
Douwe Maan committed
81

82
In most of the below cases, the notification will be sent to:
83

Douwe Maan's avatar
Douwe Maan committed
84 85 86
- Participants:
  - the author and assignee of the issue/merge request
  - authors of comments on the issue/merge request
87
  - anyone mentioned by `@username` in the title or description of the issue, merge request or epic **(ULTIMATE)**
88
  - anyone with notification level "Participating" or higher that is mentioned by `@username`
89
    in any of the comments on the issue, merge request, or epic **(ULTIMATE)**
Sean McGivern's avatar
Sean McGivern committed
90
- Watchers: users with notification level "Watch"
91
- Subscribers: anyone who manually subscribed to the issue, merge request, or epic **(ULTIMATE)**
92
- Custom: Users with notification level "custom" who turned on notifications for any of the events present in the table below
Douwe Maan's avatar
Douwe Maan committed
93 94 95

| Event                  | Sent to |
|------------------------|---------|
96 97
| New issue              |         |
| Close issue            |         |
Douwe Maan's avatar
Douwe Maan committed
98
| Reassign issue         | The above, plus the old assignee |
99
| Reopen issue           |         |
100
| Due issue              | Participants and Custom notification level with this event selected |
101 102
| Change milestone issue | Subscribers, participants mentioned, and Custom notification level with this event selected |
| Remove milestone issue | Subscribers, participants mentioned, and Custom notification level with this event selected |
103
| New merge request      |         |
104
| Push to merge request  | Participants and Custom notification level with this event selected |
Douwe Maan's avatar
Douwe Maan committed
105
| Reassign merge request | The above, plus the old assignee |
106 107 108
| Close merge request    |         |
| Reopen merge request   |         |
| Merge merge request    |         |
109 110
| Change milestone merge request | Subscribers, participants mentioned, and Custom notification level with this event selected |
| Remove milestone merge request | Subscribers, participants mentioned, and Custom notification level with this event selected |
Douwe Maan's avatar
Douwe Maan committed
111
| New comment            | The above, plus anyone mentioned by `@username` in the comment, with notification level "Mention" or higher |
Sean McGivern's avatar
Sean McGivern committed
112 113
| Failed pipeline        | The author of the pipeline |
| Successful pipeline    | The author of the pipeline, if they have the custom notification setting for successful pipelines set |
114 115 116
| New epic **(ULTIMATE)** |        |
| Close epic **(ULTIMATE)** |      |
| Reopen epic **(ULTIMATE)** |     |
Karen's avatar
Karen committed
117

118 119 120 121
In addition, if the title or description of an Issue or Merge Request is
changed, notifications will be sent to any **new** mentions by `@username` as
if they had been mentioned in the original text.

122 123 124 125
You won't receive notifications for Issues, Merge Requests or Milestones created
by yourself (except when an issue is due). You will only receive automatic
notifications when somebody else comments or adds changes to the ones that
you've created or mentions you.
126

127
If an open merge request becomes unmergeable due to conflict, its author will be notified about the cause.
128 129 130
If a user has also set the merge request to automatically merge once pipeline succeeds,
then that user will also be notified.

131 132 133 134 135 136 137 138 139 140
### Email Headers

Notification emails include headers that provide extra content about the notification received:

| Header                      | Description                                                             |
|-----------------------------|-------------------------------------------------------------------------|
| X-GitLab-Project            | The name of the project the notification belongs to                     |
| X-GitLab-Project-Id         | The ID of the project                                                   |
| X-GitLab-Project-Path       | The path of the project                                                 |
| X-GitLab-(Resource)-ID      | The ID of the resource the notification is for, where resource is `Issue`, `MergeRequest`, `Commit`, etc|
141
| X-GitLab-Discussion-ID      | Only in comment emails, the ID of the thread the comment is from    |
142 143 144
| X-GitLab-Pipeline-Id        | Only in pipeline emails, the ID of the pipeline the notification is for |
| X-GitLab-Reply-Key          | A unique token to support reply by email                                |
| X-GitLab-NotificationReason | The reason for being notified. "mentioned", "assigned", etc             |
145
| List-Id                     | The path of the project in a RFC 2919 mailing list identifier useful for email organization, for example, with GMail filters |
146 147

#### X-GitLab-NotificationReason
148

149
This header holds the reason for the notification to have been sent out,
150 151
where reason can be `mentioned`, `assigned`, `own_activity`, etc.
Only one reason is sent out according to its priority:
152

153 154 155 156
- `own_activity`
- `assigned`
- `mentioned`

157
The reason in this header will also be shown in the footer of the notification email. For example an email with the
158
reason `assigned` will have this sentence in the footer:
159 160
`"You are receiving this email because you have been assigned an item on {configured GitLab hostname}"`

161 162 163
NOTE: **Note:**
Only reasons listed above have been implemented so far.
Further implementation is [being discussed](https://gitlab.com/gitlab-org/gitlab-ce/issues/42062).