Skip to content

Create or update the Discord integration

PUT
/api/v4/groups/{id}/integrations/discord

Creates or updates the Discord integration.

id
required
One of:
string

The ID or URL-encoded path of the group

Media type application/json
object
webhook
required

Discord webhook (for example, https://discord.com/api/webhooks/…).

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
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
push_channel

The name of the channel to receive push_events notifications

string
nullable
issue_channel

The name of the channel to receive issues_events notifications

string
nullable
incident_channel

The name of the channel to receive incident_events notifications

string
nullable
alert_channel

The name of the channel to receive alert_events notifications

string
nullable
confidential_issue_channel

The name of the channel to receive confidential_issues_events notifications

string
nullable
merge_request_channel

The name of the channel to receive merge_requests_events notifications

string
nullable
note_channel

The name of the channel to receive note_events notifications

string
nullable
confidential_note_channel

The name of the channel to receive confidential_note_events notifications

string
nullable
tag_push_channel

The name of the channel to receive tag_push_events notifications

string
nullable
deployment_channel

The name of the channel to receive deployment_events notifications

string
nullable
pipeline_channel

The name of the channel to receive pipeline_events notifications

string
nullable
wiki_page_channel

The name of the channel to receive wiki_page_events notifications

string
nullable
vulnerability_channel

The name of the channel to receive vulnerability_events notifications

string
nullable
push_events

Trigger event for pushes to the repository.

boolean
nullable
issues_events

Trigger event when a work item is created, updated, or closed.

boolean
nullable
confidential_issues_events

Trigger event when a confidential work item is created, updated, or closed.

boolean
nullable
work_item_events
boolean
nullable
confidential_work_item_events
boolean
nullable
merge_requests_events

Trigger event when a merge request is created, updated, or merged.

boolean
nullable
note_events

Trigger event for new comments.

boolean
nullable
confidential_note_events

Trigger event for new comments on confidential work items.

boolean
nullable
tag_push_events

Trigger event for new tags pushed to the repository.

boolean
nullable
pipeline_events

Trigger event when a pipeline status changes.

boolean
nullable
wiki_page_events

Trigger event when a wiki page is created or updated.

boolean
nullable
deployment_events

Trigger event when a deployment starts or finishes.

boolean
nullable
use_inherited_settings

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

boolean
nullable
Example generated
{
"webhook": "example",
"notify_only_broken_pipelines": true,
"notify_only_when_pipeline_status_changes": true,
"branches_to_be_notified": "example",
"push_channel": "example",
"issue_channel": "example",
"incident_channel": "example",
"alert_channel": "example",
"confidential_issue_channel": "example",
"merge_request_channel": "example",
"note_channel": "example",
"confidential_note_channel": "example",
"tag_push_channel": "example",
"deployment_channel": "example",
"pipeline_channel": "example",
"wiki_page_channel": "example",
"vulnerability_channel": "example",
"push_events": true,
"issues_events": true,
"confidential_issues_events": true,
"work_item_events": true,
"confidential_work_item_events": true,
"merge_requests_events": true,
"note_events": true,
"confidential_note_events": true,
"tag_push_events": true,
"pipeline_events": true,
"wiki_page_events": true,
"deployment_events": true,
"use_inherited_settings": true
}

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