Notification settings

You can define notification settings globally, for groups and for projects. Valid levels are defined as constants:

  • NOTIFICATION_LEVEL_DISABLED
  • NOTIFICATION_LEVEL_PARTICIPATING
  • NOTIFICATION_LEVEL_WATCH
  • NOTIFICATION_LEVEL_GLOBAL
  • NOTIFICATION_LEVEL_MENTION
  • NOTIFICATION_LEVEL_CUSTOM

You get access to fine-grained settings if you use the NOTIFICATION_LEVEL_CUSTOM level.

  • Object classes: gitlab.objects.NotificationSettings (global), gitlab.objects.GroupNotificationSettings (groups) and gitlab.objects.ProjectNotificationSettings (projects)
  • Manager objects: gitlab.Gitlab.notificationsettings (global), gitlab.objects.Group.notificationsettings (groups) and gitlab.objects.Project.notificationsettings (projects)

Examples

Get the settings:

# global settings
settings = gl.notificationsettings.get()
# for a group
settings = gl.groups.get(group_id).notificationsettings.get()
# for a project
settings = gl.projects.get(project_id).notificationsettings.get()

Update the settings:

# use a predefined level
settings.level = gitlab.NOTIFICATION_LEVEL_WATCH
# create a custom setup
settings.level = gitlab.NOTIFICATION_LEVEL_CUSTOM
settings.save()  # will create additional attributes, but not mandatory

settings.new_merge_request = True
settings.new_issue = True
settings.new_note = True
settings.save()