GIgitlab
integrations

Create or update the Pipelines Email integration

Creates or updates the Pipelines Email integration.

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

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idinteger required

Request body

recipientsstring required

Comma-separated list of recipient email addresses.

notify_only_broken_pipelinesboolean

Send notifications for broken pipelines.

notify_only_when_pipeline_status_changesboolean

Send notifications only when the pipeline status changes.

notify_only_default_branchboolean

Send notifications for the default branch.

branches_to_be_notifiedstring

Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.

notify_child_pipelinesboolean

Send notifications for child pipelines.

pipeline_eventsboolean

Trigger event when a pipeline status changes.

use_inherited_settingsboolean

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

Response

Create or update the Pipelines Email integration

idinteger required
titlestring required
slugstring required
created_atstring date-time required
updated_atstring date-time required
activeboolean required
commit_eventsboolean required
push_eventsboolean required
issues_eventsboolean required
incident_eventsboolean required
alert_eventsboolean required
confidential_issues_eventsboolean required
merge_requests_eventsboolean required
tag_push_eventsboolean required
deployment_eventsboolean required
note_eventsboolean required
confidential_note_eventsboolean required
pipeline_eventsboolean required
wiki_page_eventsboolean required
job_eventsboolean required
comment_on_event_enabledboolean required
inheritedboolean required
vulnerability_eventsboolean required

Example response

{
  "id": 75,
  "title": "Jenkins CI",
  "slug": "jenkins",
  "created_at": "2019-11-20T11:20:25.297Z",
  "updated_at": "2019-11-20T12:24:37.498Z"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.