이 API를 사용하여 GitLab의 알림 설정을 관리합니다. 자세한 내용은 알림 이메일을 참조하세요.

알림 레벨#

알림 레벨은 NotificationSetting.level 모델 열거형에 정의되어 있습니다. 인식되는 레벨은 다음과 같습니다:

• disabled: 모든 알림 끄기
• participating: 참여한 스레드에 대한 알림 수신
• watch: 대부분의 활동에 대한 알림 수신
• global: 글로벌 알림 설정 사용
• mention: 댓글에서 언급될 때 알림 수신
• custom: 선택한 이벤트에 대한 알림 수신

custom 레벨을 사용하면 특정 이메일 이벤트를 제어할 수 있습니다. 사용 가능한 이벤트는 NotificationSetting.email_events가 반환합니다. 인식되는 이벤트는 다음과 같습니다:

글로벌 알림 설정 조회#

글로벌 알림 레벨과 이메일 주소를 조회합니다.

GET /notification_settings

요청 예시:

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

성공하면 200 OK와 다음 응답 속성을 반환합니다:

응답 예시:

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

글로벌 알림 설정 업데이트#

알림 설정과 이메일 주소를 업데이트합니다.

PUT /notification_settings

요청 예시:

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

지원되는 속성:

성공하면 200 OK와 다음 응답 속성을 반환합니다:

응답 예시:

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

알림 설정 조회#

지정된 그룹 또는 프로젝트의 알림 레벨을 조회합니다.

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

요청 예시:

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

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

지원되는 속성:

성공하면 200 OK와 다음 응답 속성을 반환합니다:

표준 알림 레벨의 응답 예시:

{
  "level": "global"
}

커스텀 알림 레벨을 가진 그룹의 응답 예시:

{
  "level": "custom",
  "events": {
    "new_release": null,
    "new_note": null,
    "new_issue": null,
    "reopen_issue": null,
    "close_issue": null,
    "reassign_issue": null,
    "issue_due": null,
    "new_merge_request": null,
    "push_to_merge_request": null,
    "reopen_merge_request": null,
    "close_merge_request": null,
    "reassign_merge_request": null,
    "change_reviewer_merge_request": null,
    "merge_merge_request": null,
    "failed_pipeline": null,
    "fixed_pipeline": null,
    "success_pipeline": null,
    "moved_project": true,
    "merge_when_pipeline_succeeds": false,
    "new_epic": null
  }
}

이 응답에서:

• true는 알림이 켜져 있음을 나타냅니다.
• false는 알림이 꺼져 있음을 나타냅니다.
• null은 알림이 기본 설정을 사용함을 나타냅니다.

그룹 또는 프로젝트 알림 설정 업데이트#

그룹 또는 프로젝트의 알림 설정을 업데이트합니다.

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

요청 예시:

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

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

지원되는 속성:

성공하면 200 OK와 다음 응답 형식 중 하나를 반환합니다.

비커스텀 알림 레벨의 경우:

{
  "level": "watch"
}

커스텀 알림 레벨의 경우 응답에는 각 알림 상태를 보여주는 events 객체가 포함됩니다:

{
  "level": "custom",
  "events": {
    "new_release": null,
    "new_note": true,
    "new_issue": false,
    "reopen_issue": null,
    "close_issue": null,
    "reassign_issue": null,
    "issue_due": null,
    "new_merge_request": null,
    "push_to_merge_request": null,
    "reopen_merge_request": null,
    "close_merge_request": null,
    "reassign_merge_request": null,
    "change_reviewer_merge_request": null,
    "merge_merge_request": null,
    "failed_pipeline": false,
    "fixed_pipeline": null,
    "success_pipeline": null,
    "moved_project": false,
    "merge_when_pipeline_succeeds": false,
    "new_epic": null
  }
}

이 응답에서:

• true는 알림이 켜져 있음을 나타냅니다.
• false는 알림이 꺼져 있음을 나타냅니다.
• null은 알림이 기본 설정을 사용함을 나타냅니다.