Create or update the Pipelines Email integration
PUT
/api/v4/groups/{id}/integrations/pipelines-email
Creates or updates the Pipelines Email integration.
Authorizations
Section titled “ Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “ Path Parameters ”Request Body required
Section titled “ Request Body required ” Media type application/json
object
recipients
required
Comma-separated list of recipient email addresses.
string
notify_only_broken_pipelines
Send notifications for broken pipelines.
boolean
notify_only_when_pipeline_status_changes
Send notifications only when the pipeline status changes.
boolean
notify_only_default_branch
Send notifications for the default branch.
boolean
branches_to_be_notified
Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.
string
notify_child_pipelines
Send notifications for child pipelines.
boolean
pipeline_events
Trigger event when a pipeline status changes.
boolean
use_inherited_settings
Indicates whether to inherit the default settings. Defaults to false.
boolean
Example generated
{ "recipients": "example", "notify_only_broken_pipelines": true, "notify_only_when_pipeline_status_changes": true, "notify_only_default_branch": true, "branches_to_be_notified": "example", "notify_child_pipelines": true, "pipeline_events": true, "use_inherited_settings": true}Responses
Section titled “ Responses ”OK
Media type application/json
object
id
integer format: int64
title
string
slug
string
created_at
string format: date-time
updated_at
string format: date-time
active
boolean
commit_events
boolean
push_events
boolean
issues_events
boolean
incident_events
boolean
alert_events
boolean
confidential_issues_events
boolean
merge_requests_events
boolean
tag_push_events
boolean
deployment_events
boolean
note_events
boolean
confidential_note_events
boolean
pipeline_events
boolean
wiki_page_events
boolean
job_events
boolean
comment_on_event_enabled
boolean
inherited
boolean
vulnerability_events
boolean
Example
{ "id": 75, "title": "Jenkins CI", "slug": "jenkins", "created_at": "2019-11-20T11:20:25.297Z", "updated_at": "2019-11-20T12:24:37.498Z"}Bad request
Unauthorized
Not found
Unprocessable entity