Notification settings API

原文：https://docs.gitlab.com/ee/api/notification_settings.html

• Valid notification levels
• Global notification settings
• Update global notification settings
• Group / project level notification settings
• Update group/project level notification settings

Notification settings API

在 GitLab 8.12 中引入 .

Valid notification levels

通知级别在NotificationSetting.level模型枚举中定义. 当前，这些级别被认可：

disabled
participating
watch
global
mention
custom

如果使用custom级别，则可以控制特定的电子邮件事件. 可用事件由NotificationSetting.email_events返回. 当前，这些事件被认可：

• new_note
• new_issue
• reopen_issue
• close_issue
• reassign_issue
• issue_due
• new_merge_request
• push_to_merge_request
• reopen_merge_request
• close_merge_request
• reassign_merge_request
• merge_merge_request
• failed_pipeline
• fixed_pipeline
• success_pipeline
• new_epic

Global notification settings

获取当前的通知设置和电子邮件地址.

GET /notification_settings

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/notification_settings"

响应示例：

{  "level":  "participating",  "notification_email":  "admin@example.com"  }

Update global notification settings

更新当前的通知设置和电子邮件地址.

PUT /notification_settings

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/notification_settings?level=watch"

响应示例：

{  "level":  "watch",  "notification_email":  "admin@example.com"  }

Group / project level notification settings

获取当前的组或项目通知设置.

GET /groups/:id/notification_settings
GET /projects/:id/notification_settings

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/notification_settings"
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/8/notification_settings"

响应示例：

{  "level":  "global"  }

Update group/project level notification settings

更新当前的组/项目通知设置.

PUT /groups/:id/notification_settings
PUT /projects/:id/notification_settings

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/notification_settings?level=watch"
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/8/notification_settings?level=custom&new_note=true"

响应示例：

{  "level":  "watch"  }  {  "level":  "custom",  "events":  {  "new_note":  true,  "new_issue":  false,  "reopen_issue":  false,  "close_issue":  false,  "reassign_issue":  false,  "issue_due":  false,  "new_merge_request":  false,  "push_to_merge_request":  false,  "reopen_merge_request":  false,  "close_merge_request":  false,  "reassign_merge_request":  false,  "merge_merge_request":  false,  "failed_pipeline":  false,  "fixed_pipeline":  false,  "success_pipeline":  false  }  }

使用 GitLab Ultimate 或 Gold 的用户还将看到new_epic参数：

{  "level":  "custom",  "events":  {  "new_note":  true,  "new_issue":  false,  "new_epic":  false,  ...  }  }