Create or update the Pipelines Email integration

PUT

/api/v4/projects/{id}/services/pipelines-email

• GitLab REST API

Creates or updates the Pipelines Email integration.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the project

Example

1

Request Body ^required

Media type application/json

object

recipients

required

Comma-separated list of recipient email addresses.

string

nullable

notify_only_broken_pipelines

Send notifications for broken pipelines.

boolean

nullable

notify_only_when_pipeline_status_changes

Send notifications only when the pipeline status changes.

boolean

nullable

notify_only_default_branch

Send notifications for the default branch.

boolean

nullable

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

nullable

notify_child_pipelines

Send notifications for child pipelines.

boolean

nullable

pipeline_events

Trigger event when a pipeline status changes.

boolean

nullable

use_inherited_settings

Indicates whether to inherit the default settings. Defaults to false.

boolean

nullable

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

200

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"
}

400

Bad request

401

Unauthorized

404

Not found

422

Unprocessable entity