Group integrations API

Use this API to work with external services that integrate with GitLab.

This API requires an access token with the Maintainer or Owner role.

List all active integrations

Get a list of all active group integrations. The vulnerability_events field is only available for GitLab Enterprise Edition.

GET /groups/:id/integrations

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",
    "active": true,
    "commit_events": true,
    "push_events": true,
    "issues_events": true,
    "alert_events": true,
    "confidential_issues_events": true,
    "merge_requests_events": true,
    "tag_push_events": false,
    "deployment_events": false,
    "note_events": true,
    "confidential_note_events": true,
    "pipeline_events": true,
    "wiki_page_events": true,
    "job_events": true,
    "comment_on_event_enabled": true,
    "inherited": false,
    "vulnerability_events": true
  },
  {
    "id": 76,
    "title": "Alerts endpoint",
    "slug": "alerts",
    "created_at": "2019-11-20T11:20:25.297Z",
    "updated_at": "2019-11-20T12:24:37.498Z",
    "active": true,
    "commit_events": true,
    "push_events": true,
    "issues_events": true,
    "alert_events": true,
    "confidential_issues_events": true,
    "merge_requests_events": true,
    "tag_push_events": true,
    "deployment_events": false,
    "note_events": true,
    "confidential_note_events": true,
    "pipeline_events": true,
    "wiki_page_events": true,
    "job_events": true,
    "comment_on_event_enabled": true,
    "inherited": false,
    "vulnerability_events": true
  }
]

Asana

Set up Asana

Set up the Asana integration for a group.

PUT /groups/:id/integrations/asana

Parameters:

Disable Asana

Disable the Asana integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/asana

Get Asana settings

Get the Asana integration settings for a group.

GET /groups/:id/integrations/asana

Assembla

Set up Assembla

Set up the Assembla integration for a group.

PUT /groups/:id/integrations/assembla

Parameters:

Disable Assembla

Disable the Assembla integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/assembla

Get Assembla settings

Get the Assembla integration settings for a group.

GET /groups/:id/integrations/assembla

Atlassian Bamboo

Set up Atlassian Bamboo

Set up the Atlassian Bamboo integration for a group.

You must configure automatic revision labeling and a repository trigger in Bamboo.

PUT /groups/:id/integrations/bamboo

Parameters:

Disable Atlassian Bamboo

Disable the Atlassian Bamboo integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/bamboo

Get Atlassian Bamboo settings

Get the Atlassian Bamboo integration settings for a group.

GET /groups/:id/integrations/bamboo

Bugzilla

Set up Bugzilla

Set up the Bugzilla integration for a group.

PUT /groups/:id/integrations/bugzilla

Parameters:

Disable Bugzilla

Disable the Bugzilla integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/bugzilla

Get Bugzilla settings

Get the Bugzilla integration settings for a group.

GET /groups/:id/integrations/bugzilla

Buildkite

Set up Buildkite

Set up the Buildkite integration for a group.

PUT /groups/:id/integrations/buildkite

Parameters:

Disable Buildkite

Disable the Buildkite integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/buildkite

Get Buildkite settings

Get the Buildkite integration settings for a group.

GET /groups/:id/integrations/buildkite

Campfire Classic

You can integrate with Campfire Classic. However, Campfire Classic is an old product that is no longer sold by Basecamp.

Set up Campfire Classic

Set up the Campfire Classic integration for a group.

PUT /groups/:id/integrations/campfire

Parameters:

Disable Campfire Classic

Disable the Campfire Classic integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/campfire

Get Campfire Classic settings

Get the Campfire Classic integration settings for a group.

GET /groups/:id/integrations/campfire

ClickUp

Set up ClickUp

Set up the ClickUp integration for a group.

PUT /groups/:id/integrations/clickup

Parameters:

Disable ClickUp

Disable the ClickUp integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/clickup

Get ClickUp settings

Get the ClickUp integration settings for a group.

GET /groups/:id/integrations/clickup

Confluence Workspace

Set up Confluence Workspace

Set up the Confluence Workspace integration for a group.

PUT /groups/:id/integrations/confluence

Parameters:

Disable Confluence Workspace

Disable the Confluence Workspace integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/confluence

Get Confluence Workspace settings

Get the Confluence Workspace integration settings for a group.

GET /groups/:id/integrations/confluence

Custom issue tracker

Set up a custom issue tracker

Set up a custom issue tracker for a group.

PUT /groups/:id/integrations/custom-issue-tracker

Parameters:

Disable a custom issue tracker

Disable a custom issue tracker for a group. Integration settings are reset.

DELETE /groups/:id/integrations/custom-issue-tracker

Get custom issue tracker settings

Get the custom issue tracker settings for a group.

GET /groups/:id/integrations/custom-issue-tracker

Datadog

Set up Datadog

Set up the Datadog integration for a group.

PUT /groups/:id/integrations/datadog

Parameters:

Disable Datadog

Disable the Datadog integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/datadog

Get Datadog settings

Get the Datadog integration settings for a group.

GET /groups/:id/integrations/datadog

Diffblue Cover

Set up Diffblue Cover

Set up the Diffblue Cover integration for a group.

PUT /groups/:id/integrations/diffblue-cover

Parameters:

Disable Diffblue Cover

Disable the Diffblue Cover integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/diffblue-cover

Get Diffblue Cover settings

Get the Diffblue Cover integration settings for a group.

GET /groups/:id/integrations/diffblue-cover

Discord Notifications

Set up Discord Notifications

Set up Discord Notifications for a group.

PUT /groups/:id/integrations/discord

Parameters:

Disable Discord Notifications

Disable Discord Notifications for a group. Integration settings are reset.

DELETE /groups/:id/integrations/discord

Get Discord Notifications settings

Get the Discord Notifications settings for a group.

GET /groups/:id/integrations/discord

Drone

Set up Drone

Set up the Drone integration for a group.

PUT /groups/:id/integrations/drone-ci

Parameters:

Disable Drone

Disable the Drone integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/drone-ci

Get Drone settings

Get the Drone integration settings for a group.

GET /groups/:id/integrations/drone-ci

Emails on push

Set up emails on push

Set up the emails on push integration for a group.

PUT /groups/:id/integrations/emails-on-push

Parameters:

Disable emails on push

Disable the emails on push integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/emails-on-push

Get emails on push settings

Get the emails on push integration settings for a group.

GET /groups/:id/integrations/emails-on-push

Engineering Workflow Management (EWM)

Set up EWM

Set up the EWM integration for a group.

PUT /groups/:id/integrations/ewm

Parameters:

Disable EWM

Disable the EWM integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/ewm

Get EWM settings

Get the EWM integration settings for a group.

GET /groups/:id/integrations/ewm

External wiki

Set up an external wiki

Set up an external wiki for a group.

PUT /groups/:id/integrations/external-wiki

Parameters:

Disable an external wiki

Disable an external wiki for a group. Integration settings are reset.

DELETE /groups/:id/integrations/external-wiki

Get external wiki settings

Get the external wiki settings for a group.

GET /groups/:id/integrations/external-wiki

GitGuardian

GitGuardian is a cybersecurity service that detects sensitive data such as API keys and passwords in source code repositories. It scans Git repositories, alerts on policy violations, and helps organizations fix security issues before hackers can exploit them.

You can configure GitLab to reject commits based on GitGuardian policies.

Known issues

• Pushes can be delayed or can time out. With the GitGuardian integration, pushes are sent to a third-party, and GitLab has no control over the connection with GitGuardian or the GitGuardian process.
• Due to a GitGuardian API limitation, the integration ignores files over the size of 1 MB. They are not scanned.
• If a pushed file has a name over 256 characters long the push won’t go through. For more information, see GitGuardian API documentation .

Troubleshooting steps on the integration page show how to mitigate some of these problems.

Set up GitGuardian

Set up the GitGuardian integration for a group.

PUT /groups/:id/integrations/git-guardian

Parameters:

Disable GitGuardian

Disable the GitGuardian integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/git-guardian

Get GitGuardian settings

Get the GitGuardian integration settings for a group.

GET /groups/:id/integrations/git-guardian

GitHub

Set up GitHub

Set up the GitHub integration for a group.

PUT /groups/:id/integrations/github

Parameters:

Disable GitHub

Disable the GitHub integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/github

Get GitHub settings

Get the GitHub integration settings for a group.

GET /groups/:id/integrations/github

GitLab for Jira Cloud app

The GitLab for Jira Cloud app integration is enabled or disabled automatically through group linking and unlinking in Jira. You cannot enable or disable the integration with the GitLab integrations form or the API.

Update integration for a group

Use this API endpoint to update an integration you create with group linking in Jira.

PUT /groups/:id/integrations/jira-cloud-app

Parameters:

Get GitLab for Jira Cloud app settings

Get the GitLab for Jira Cloud app integration settings for a group.

GET /groups/:id/integrations/jira-cloud-app

GitLab for Slack app

Set up GitLab for Slack app

Update the GitLab for Slack app integration for a group.

You cannot create a GitLab for Slack app through the API because the integration requires an OAuth 2.0 token that you cannot get from the GitLab API alone. Instead, you must install the app from the GitLab UI. You can then use this API endpoint to update the integration.

PUT /groups/:id/integrations/gitlab-slack-application

Parameters:

Disable GitLab for Slack app

Disable the GitLab for Slack app integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/gitlab-slack-application

Get GitLab for Slack app settings

Get the GitLab for Slack app integration settings for a group.

GET /groups/:id/integrations/gitlab-slack-application

Google Chat

Set up Google Chat

Set up the Google Chat integration for a group.

PUT /groups/:id/integrations/hangouts-chat

Parameters:

Disable Google Chat

Disable the Google Chat integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/hangouts-chat

Get Google Chat settings

Get the Google Chat integration settings for a group.

GET /groups/:id/integrations/hangouts-chat

Google Artifact Management

This feature is in beta.

Set up Google Artifact Management

Set up the Google Artifact Management integration for a group.

PUT /groups/:id/integrations/google-cloud-platform-artifact-registry

Parameters:

Disable Google Artifact Management

Disable the Google Artifact Management integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/google-cloud-platform-artifact-registry

Get Google Artifact Management settings

Get the Google Artifact Management integration settings for a group.

GET /groups/:id/integrations/google-cloud-platform-artifact-registry

Google Cloud Identity and Access Management (IAM)

This feature is in beta.

Set up Google Cloud Identity and Access Management

Set up the Google Cloud Identity and Access Management integration for a group.

PUT /groups/:id/integrations/google-cloud-platform-workload-identity-federation

Parameters:

Disable Google Cloud Identity and Access Management

Disable the Google Cloud Identity and Access Management integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/google-cloud-platform-workload-identity-federation

Get Google Cloud Identity and Access Management

Get the settings for the Google Cloud Identity and Access Management for a group.

GET /groups/:id/integration/google-cloud-platform-workload-identity-federation

Harbor

Set up Harbor

Set up the Harbor integration for a group.

PUT /groups/:id/integrations/harbor

Parameters:

Disable Harbor

Disable the Harbor integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/harbor

Get Harbor settings

Get the Harbor integration settings for a group.

GET /groups/:id/integrations/harbor

irker (IRC gateway)

Set up irker

Set up the irker integration for a group.

PUT /groups/:id/integrations/irker

Parameters:

Disable irker

Disable the irker integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/irker

Get irker settings

Get the irker integration settings for a group.

GET /groups/:id/integrations/irker

JetBrains TeamCity

Set up JetBrains TeamCity

Set up the JetBrains TeamCity integration for a group.

The build configuration in TeamCity must use the build number format %build.vcs.number%. In the advanced settings for VCS root, configure monitoring for all branches so merge requests can build.

PUT /groups/:id/integrations/teamcity

Parameters:

Disable JetBrains TeamCity

Disable the JetBrains TeamCity integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/teamcity

Get JetBrains TeamCity settings

Get the JetBrains TeamCity integration settings for a group.

GET /groups/:id/integrations/teamcity

Jira

Set up Jira

Set up the Jira integration for a group.

PUT /groups/:id/integrations/jira

Parameters:

Disable Jira

Disable the Jira integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/jira

Get Jira settings

Get the Jira integration settings for a group.

GET /groups/:id/integrations/jira

Matrix notifications

Set up Matrix notifications

Set up Matrix notifications for a group.

PUT /groups/:id/integrations/matrix

Parameters:

Disable Matrix notifications

Disable Matrix notifications for a group. Integration settings are reset.

DELETE /groups/:id/integrations/matrix

Get Matrix notifications settings

Get the Matrix notifications settings for a group.

GET /groups/:id/integrations/matrix

Mattermost notifications

Set up Mattermost notifications

Set up Mattermost notifications for a group.

PUT /groups/:id/integrations/mattermost

Parameters:

Disable Mattermost notifications

Disable Mattermost notifications for a group. Integration settings are reset.

DELETE /groups/:id/integrations/mattermost

Get Mattermost notifications settings

Get the Mattermost notifications settings for a group.

GET /groups/:id/integrations/mattermost

Mattermost slash commands

Set up Mattermost slash commands

Set up Mattermost slash commands for a group.

PUT /groups/:id/integrations/mattermost-slash-commands

Parameters:

Disable Mattermost slash commands

Disable Mattermost slash commands for a group. Integration settings are reset.

DELETE /groups/:id/integrations/mattermost-slash-commands

Get Mattermost slash commands settings

Get the Mattermost slash commands settings for a group.

GET /groups/:id/integrations/mattermost-slash-commands

Microsoft Teams notifications

Set up Microsoft Teams notifications

Set up Microsoft Teams notifications for a group.

PUT /groups/:id/integrations/microsoft-teams

Parameters:

Disable Microsoft Teams notifications

Disable Microsoft Teams notifications for a group. Integration settings are reset.

DELETE /groups/:id/integrations/microsoft-teams

Get Microsoft Teams notifications settings

Get the Microsoft Teams notifications settings for a group.

GET /groups/:id/integrations/microsoft-teams

Mock CI

This integration is only available in a development environment. For an example Mock CI server, see gitlab-org/gitlab-mock-ci-service.

Set up Mock CI

Set up the Mock CI integration for a group.

PUT /groups/:id/integrations/mock-ci

Parameters:

Disable Mock CI

Disable the Mock CI integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/mock-ci

Get Mock CI settings

Get the Mock CI integration settings for a group.

GET /groups/:id/integrations/mock-ci

Packagist

Set up Packagist

Set up the Packagist integration for a group.

PUT /groups/:id/integrations/packagist

Parameters:

Disable Packagist

Disable the Packagist integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/packagist

Get Packagist settings

Get the Packagist integration settings for a group.

GET /groups/:id/integrations/packagist

Phorge

Set up Phorge

Set up the Phorge integration for a group.

PUT /groups/:id/integrations/phorge

Parameters:

Disable Phorge

Disable the Phorge integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/phorge

Get Phorge settings

Get the Phorge integration settings for a group.

GET /groups/:id/integrations/phorge

Pipeline status emails

Set up pipeline status emails

Set up pipeline status emails for a group.

PUT /groups/:id/integrations/pipelines-email

Parameters:

Disable pipeline status emails

Disable pipeline status emails for a group. Integration settings are reset.

DELETE /groups/:id/integrations/pipelines-email

Get pipeline status emails settings

Get the pipeline status emails settings for a group.

GET /groups/:id/integrations/pipelines-email

Pivotal Tracker

Set up Pivotal Tracker

Set up the Pivotal Tracker integration for a group.

PUT /groups/:id/integrations/pivotaltracker

Parameters:

Disable Pivotal Tracker

Disable the Pivotal Tracker integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/pivotaltracker

Get Pivotal Tracker settings

Get the Pivotal Tracker integration settings for a group.

GET /groups/:id/integrations/pivotaltracker

Pumble

Set up Pumble

Set up the Pumble integration for a group.

PUT /groups/:id/integrations/pumble

Parameters:

Disable Pumble

Disable the Pumble integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/pumble

Get Pumble settings

Get the Pumble integration settings for a group.

GET /groups/:id/integrations/pumble

Pushover

Set up Pushover

Set up the Pushover integration for a group.

PUT /groups/:id/integrations/pushover

Parameters:

Disable Pushover

Disable the Pushover integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/pushover

Get Pushover settings

Get the Pushover integration settings for a group.

GET /groups/:id/integrations/pushover

Redmine

Set up Redmine

Set up the Redmine integration for a group.

PUT /groups/:id/integrations/redmine

Parameters:

Disable Redmine

Disable the Redmine integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/redmine

Get Redmine settings

Get the Redmine integration settings for a group.

GET /groups/:id/integrations/redmine

Slack notifications

Set up Slack notifications

Set up Slack notifications for a group.

PUT /groups/:id/integrations/slack

Parameters:

Disable Slack notifications

Disable Slack notifications for a group. Integration settings are reset.

DELETE /groups/:id/integrations/slack

Get Slack notifications settings

Get the Slack notifications settings for a group.

GET /groups/:id/integrations/slack

Slack slash commands

Set up Slack slash commands

Set up Slack slash commands for a group.

PUT /groups/:id/integrations/slack-slash-commands

Parameters:

Disable Slack slash commands

Disable Slack slash commands for a group. Integration settings are reset.

DELETE /groups/:id/integrations/slack-slash-commands

Get Slack slash commands settings

Get the Slack slash commands settings for a group.

GET /groups/:id/integrations/slack-slash-commands

Example response:

{
  "id": 4,
  "title": "Slack slash commands",
  "slug": "slack-slash-commands",
  "created_at": "2017-06-27T05:51:39-07:00",
  "updated_at": "2017-06-27T05:51:39-07:00",
  "active": true,
  "push_events": true,
  "issues_events": true,
  "confidential_issues_events": true,
  "merge_requests_events": true,
  "tag_push_events": true,
  "note_events": true,
  "job_events": true,
  "pipeline_events": true,
  "comment_on_event_enabled": false,
  "inherited": false,
  "properties": {
    "token": "<your_access_token>"
  }
}

Squash TM

Set up Squash TM

Set up the Squash TM integration settings for a group.

PUT /groups/:id/integrations/squash-tm

Parameters:

Disable Squash TM

Disable the Squash TM integration for a group. Integration settings are preserved.

DELETE /groups/:id/integrations/squash-tm

Get Squash TM settings

Get the Squash TM integration settings for a group.

GET /groups/:id/integrations/squash-tm

Telegram

Set up Telegram

Set up the Telegram integration for a group.

PUT /groups/:id/integrations/telegram

Parameters:

Disable Telegram

Disable the Telegram integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/telegram

Get Telegram settings

Get the Telegram integration settings for a group.

GET /groups/:id/integrations/telegram

Unify Circuit

Set up Unify Circuit

Set up the Unify Circuit integration for a group.

PUT /groups/:id/integrations/unify-circuit

Parameters:

Disable Unify Circuit

Disable the Unify Circuit integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/unify-circuit

Get Unify Circuit settings

Get the Unify Circuit integration settings for a group.

GET /groups/:id/integrations/unify-circuit

Webex Teams

Set up Webex Teams

Set up Webex Teams for a group.

PUT /groups/:id/integrations/webex-teams

Parameters:

Disable Webex Teams

Disable Webex Teams for a group. Integration settings are reset.

DELETE /groups/:id/integrations/webex-teams

Get Webex Teams settings

Get the Webex Teams settings for a group.

GET /groups/:id/integrations/webex-teams

YouTrack

Set up YouTrack

Set up the YouTrack integration for a group.

PUT /groups/:id/integrations/youtrack

Parameters:

Disable YouTrack

Disable the YouTrack integration for a group. Integration settings are reset.

DELETE /groups/:id/integrations/youtrack

Get YouTrack settings

Get the YouTrack integration settings for a group.

GET /groups/:id/integrations/youtrack