Integrations and services

Configuring integrations and project services

Group and project entries accept an integrations map keyed by GitLab's integration slug, plus project service singletons: Pages settings, error tracking, the CI/CD job token scope toggle, and group-level merge request approval settings.

Integration secret handling

Integration secret classification is by exact name and suffix, not substring: the exact names key, password, secret, token, and webhook; a named set (api_key, user_key, service_account_key, diffblue_license_key); and the suffixes _api_key, _access_key, _private_key, _password, _secret, _secret_key, _token. Secret fields are never compared or shown in diffs but are carried on every write so GitLab's required-parameter validation stays satisfied. force_secret_update: true forces a rotation write when nothing else drifted. Exempt shapes (project_key, project_keys, jira_issue_prefix, and the suffixes _key_id, _file_name, _token_name) reconcile normally. Integration URL fields (url, api_url, jenkins_url, and friends) are private values: fingerprinted for comparison and never displayed in diffs. GitLab returns integration configuration under a properties object; declared fields are compared against that object.

Example integrations definition

gitlab_settings_projects:
  - path: platform/service
    integrations:
      slack:
        webhook: "{{ vault_slack_webhook }}"
        username: gitlab
        notify_only_broken_pipelines: true
      jira:
        url: https://jira.example.com
        username: gitlab-bot
        password: "{{ vault_jira_password }}"
    pages:
      pages_unique_domain_enabled: true
    error_tracking:
      active: true
      integrated: true
    job_token_scope:
      enabled: true

gitlab_settings_groups:
  - path: platform
    integrations:
      slack:
        webhook: "{{ vault_slack_webhook }}"
    approvals:
      settings:
        allow_author_approval: false

Integrations And Services Spec

GitLab API reference

GitLab's API documentation defines the fields per surface:

1. Integrations API (fields per slug)
2. Pages API
3. Error tracking API
4. Job token scope API
5. Group approval settings

integrations object (map by slug)  Available on group and project entries. Each map key selects one GitLab integration; an unconfigured integration is configured on first apply. Properties of each integrations.<slug> The disclosures below list the writable fields for every supported integration slug. Required markers come from each integration's PUT request schema. Accepted fields for apple-app-store  app_store_issuer_id stringRequired Apple App Store Connect issuer ID.  app_store_key_id stringRequired Apple App Store Connect key ID.  app_store_private_key_file_name stringRequired Apple App Store Connect private key file name.  app_store_private_key stringRequired Apple App Store Connect private key.  app_store_protected_refs boolean Set variables on protected branches and tags only.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for asana  api_key stringRequired User API token. The user must have access to the task. All comments are attributed to this user.  restrict_to_branch string Comma-separated list of branches to be automatically inspected. Leave blank to include all branches.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for assembla  token stringRequired The authentication token.  subdomain string The subdomain setting.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for bamboo  enable_ssl_verification boolean Enable SSL verification. Defaults to true (enabled).  bamboo_url stringRequired Bamboo root URL (for example, https://bamboo.example.com).  build_key stringRequired Bamboo build plan key (for example, KEY).  username stringRequired User with API access to the Bamboo server.  password stringRequired Password of the user.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for bugzilla  project_url stringRequired URL of the project.  issues_url stringRequired URL of the issue.  new_issue_url stringRequired URL of the new issue.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for buildkite  project_url stringRequired Pipeline URL (for example, https://buildkite.com/example/pipeline).  token stringRequired Token you get after you create a Buildkite pipeline with a GitLab repository.  push_events boolean Trigger event for pushes to the repository.  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  tag_push_events boolean Trigger event for new tags pushed to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for campfire  token stringRequired API authentication token from Campfire. To get the token, sign in to Campfire and select My info.  subdomain string .campfirenow.com subdomain when you're signed in.  room string ID portion of the Campfire room URL.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for clickup  project_url stringRequired URL of the project.  issues_url stringRequired URL of the issue.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for confluence  confluence_url stringRequired URL of the Confluence Workspace hosted on atlassian.net.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for custom-issue-tracker  project_url stringRequired URL of the project.  issues_url stringRequired URL of the issue.  new_issue_url stringRequired URL of the new issue.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for datadog  datadog_site string Datadog site to send data to.  api_url stringRequired for a custom site Full URL of your Datadog site. Only required if you do not use a standard Datadog site.  api_key stringRequired API key used for authentication with Datadog.  datadog_ci_visibility boolean Enable CI Visibility  archive_trace_events boolean When enabled, job logs are collected by Datadog and displayed along with pipeline execution traces.  datadog_service string Tag all pipeline data from this GitLab instance in Datadog. Can be used when managing several self-managed deployments.  datadog_env string For self-managed deployments, env tag for all the data sent to Datadog.  datadog_tags string Custom tags in Datadog. Specify one tag per line in the format key:value\nkey2:value2.  pipeline_events boolean Trigger event when a pipeline status changes.  build_events boolean Trigger event when a build is created.  push_events boolean Trigger event for pushes to the repository.  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  note_events boolean Trigger event for new comments.  tag_push_events boolean Trigger event for new tags pushed to the repository.  subgroup_events boolean  project_events boolean  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for diffblue-cover  diffblue_license_key stringRequired Diffblue Cover license key.  diffblue_access_token_name stringRequired Access token name used by Diffblue Cover in pipelines.  diffblue_access_token_secret stringRequired Access token secret used by Diffblue Cover in pipelines.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for discord  webhook stringRequired Discord webhook (for example, https://discord.com/api/webhooks/…).  notify_only_broken_pipelines boolean Send notifications for broken pipelines.  notify_only_when_pipeline_status_changes boolean Send notifications only when the pipeline status changes.  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  push_channel string The name of the channel to receive push_events notifications  issue_channel string The name of the channel to receive issues_events notifications  incident_channel string The name of the channel to receive incident_events notifications  alert_channel string The name of the channel to receive alert_events notifications  confidential_issue_channel string The name of the channel to receive confidential_issues_events notifications  merge_request_channel string The name of the channel to receive merge_requests_events notifications  note_channel string The name of the channel to receive note_events notifications  confidential_note_channel string The name of the channel to receive confidential_note_events notifications  tag_push_channel string The name of the channel to receive tag_push_events notifications  deployment_channel string The name of the channel to receive deployment_events notifications  pipeline_channel string The name of the channel to receive pipeline_events notifications  wiki_page_channel string The name of the channel to receive wiki_page_events notifications  vulnerability_channel string The name of the channel to receive vulnerability_events notifications  push_events boolean Trigger event for pushes to the repository.  issues_events boolean Trigger event when a work item is created, updated, or closed.  confidential_issues_events boolean Trigger event when a confidential work item is created, updated, or closed.  work_item_events boolean  confidential_work_item_events boolean  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  note_events boolean Trigger event for new comments.  confidential_note_events boolean Trigger event for new comments on confidential work items.  tag_push_events boolean Trigger event for new tags pushed to the repository.  pipeline_events boolean Trigger event when a pipeline status changes.  wiki_page_events boolean Trigger event when a wiki page is created or updated.  deployment_events boolean Trigger event when a deployment starts or finishes.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for drone-ci  enable_ssl_verification boolean Enable SSL verification. Defaults to true (enabled).  drone_url stringRequired Drone CI URL (for example, http://drone.example.com).  token stringRequired Drone CI token.  push_events boolean Trigger event for pushes to the repository.  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  tag_push_events boolean Trigger event for new tags pushed to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for emails-on-push  send_from_committer_email boolean Send from committer  disable_diffs boolean Disable code diffs  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  recipients stringRequired Emails separated by whitespace.  push_events boolean Trigger event for pushes to the repository.  tag_push_events boolean Trigger event for new tags pushed to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for ewm  project_url stringRequired URL of the project.  issues_url stringRequired URL of the issue.  new_issue_url stringRequired URL of the new issue.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for external-wiki  external_wiki_url stringRequired URL of the external wiki.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for git-guardian  api_url string GitGuardian API base URL. Defaults to https://api.gitguardian.com. Use https://api.eu1.gitguardian.com for the EU region, or the URL of your self-hosted GitGuardian instance. Must use HTTPS.  token stringRequired Personal access token to authenticate calls to the GitGuardian API.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for github  token stringRequired GitHub API token with repo:status OAuth scope.  repository_url stringRequired GitHub repository URL.  static_context boolean Append the hostname of your GitLab instance to the status check name.  pipeline_events boolean Trigger event when a pipeline status changes.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for gitlab-slack-application  channel string Default channel to use if no other channel is configured.  notify_only_broken_pipelines boolean Send notifications for broken pipelines.  notify_only_when_pipeline_status_changes boolean Send notifications only when the pipeline status changes.  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  labels_to_be_notified string Labels to send notifications for. Leave blank to receive notifications for all events.  labels_to_be_notified_behavior string Labels to be notified for. Valid options are match_any and match_all. The default value is match_any.  push_channel string The name of the channel to receive push_events notifications  issue_channel string The name of the channel to receive issues_events notifications  incident_channel string The name of the channel to receive incident_events notifications  alert_channel string The name of the channel to receive alert_events notifications  confidential_issue_channel string The name of the channel to receive confidential_issues_events notifications  merge_request_channel string The name of the channel to receive merge_requests_events notifications  note_channel string The name of the channel to receive note_events notifications  confidential_note_channel string The name of the channel to receive confidential_note_events notifications  tag_push_channel string The name of the channel to receive tag_push_events notifications  deployment_channel string The name of the channel to receive deployment_events notifications  pipeline_channel string The name of the channel to receive pipeline_events notifications  wiki_page_channel string The name of the channel to receive wiki_page_events notifications  vulnerability_channel string The name of the channel to receive vulnerability_events notifications  push_events boolean Trigger event for pushes to the repository.  issues_events boolean Trigger event when a work item is created, updated, or closed.  confidential_issues_events boolean Trigger event when a confidential work item is created, updated, or closed.  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  note_events boolean Trigger event for new comments.  confidential_note_events boolean Trigger event for new comments on confidential work items.  tag_push_events boolean Trigger event for new tags pushed to the repository.  pipeline_events boolean Trigger event when a pipeline status changes.  wiki_page_events boolean Trigger event when a wiki page is created or updated.  deployment_events boolean Trigger event when a deployment starts or finishes.  incident_events boolean Trigger event when an incident is created.  work_item_events boolean  confidential_work_item_events boolean  vulnerability_events boolean  alert_events boolean Trigger event when a new, unique alert is recorded.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for google-cloud-platform-artifact-registry  artifact_registry_project_id stringRequired ID of the Google Cloud project.  artifact_registry_repositories stringRequired Repository of Artifact Registry.  artifact_registry_location stringRequired Location of the Artifact Registry repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for google-cloud-platform-workload-identity-federation  workload_identity_federation_project_id stringRequired Google Cloud project ID for the Workload Identity Federation.  workload_identity_federation_project_number stringRequired Google Cloud project number for the Workload Identity Federation.  workload_identity_pool_id stringRequired ID of the Workload Identity Pool.  workload_identity_pool_provider_id stringRequired ID of the Workload Identity Pool provider.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for google-play  package_name stringRequired Package name of the app in Google Play.  service_account_key_file_name stringRequired File name of the Google Play service account key.  service_account_key stringRequired Google Play service account key.  google_play_protected_refs boolean Set variables on protected branches and tags only.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for hangouts-chat  webhook stringRequired The Hangouts Chat webhook (for example, https://chat.googleapis.com/v1/spaces...).  notify_only_broken_pipelines boolean Send notifications for broken pipelines.  notify_only_when_pipeline_status_changes boolean Send notifications only when the pipeline status changes.  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  push_events boolean Trigger event for pushes to the repository.  issues_events boolean Trigger event when a work item is created, updated, or closed.  confidential_issues_events boolean Trigger event when a confidential work item is created, updated, or closed.  work_item_events boolean  confidential_work_item_events boolean  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  note_events boolean Trigger event for new comments.  confidential_note_events boolean Trigger event for new comments on confidential work items.  tag_push_events boolean Trigger event for new tags pushed to the repository.  pipeline_events boolean Trigger event when a pipeline status changes.  wiki_page_events boolean Trigger event when a wiki page is created or updated.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for harbor  url stringRequired The base URL to the Harbor instance linked to the GitLab project. For example, https://demo.goharbor.io.  project_name stringRequired The name of the project in the Harbor instance. For example, testproject.  username stringRequired The username created in the Harbor interface.  password stringRequired The password of the user.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for irker  server_host string irker daemon hostname. The default value is localhost.  server_port integer irker daemon port. The default value is 6659.  default_irc_uri string URI to add before each recipient. The default value is irc://irc.network.net:6697/.  recipients stringRequired Comma-separated list of channels or email addresses.  colorize_messages boolean Colorize messages  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for jenkins  enable_ssl_verification boolean Enable SSL verification. Defaults to true (enabled).  jenkins_url stringRequired URL of the Jenkins server.  project_name stringRequired Name of the Jenkins project.  username string Username of the Jenkins server.  password string Password of the Jenkins server.  push_events boolean Trigger event for pushes to the repository.  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  tag_push_events boolean Trigger event for new tags pushed to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for jira  url stringRequired The URL to the Jira project which is being linked to this GitLab project (for example, https://jira.example.com).  api_url string The base URL to the Jira instance API. Web URL value is used if not set (for example, https://jira-api.example.com).  jira_auth_type integer The authentication method to use with Jira. Use 0 for basic authentication, 1 for Jira personal access token, and 2 for Jira Cloud service accounts. Defaults to 0.  username stringRequired for basic authentication The email or username to use with Jira. Use an email for Jira Cloud, and a username for Jira Data Center and Jira Server. Required when using basic authentication (jira_auth_type is 0).  password stringRequired The Jira API token, password, or personal access token to use with Jira. When using Basic Authentication (jira_auth_type is 0), use an API token for Jira Cloud, and a password for Jira Data Center or Jira Server. For a Jira personal access token (jira_auth_type is 1), use the personal access token.  jira_issue_regex string Regular expression to match Jira issue keys.  jira_issue_prefix string Prefix to match Jira issue keys.  jira_issue_transition_id string ID of one or more custom Jira issue transitions. Ignored when jira_issue_transition_automatic is enabled. A blank string disables custom transitions.  issues_enabled string Enable viewing Jira issues in GitLab.  project_keys array of strings Keys of Jira projects to display. When issues_enabled is true, this setting filters which Jira projects are shown in GitLab. It does not restrict the API token's access.  vulnerabilities_enabled boolean Turn on Jira issue creation for GitLab vulnerabilities.  vulnerabilities_issuetype string Jira issue type to use when creating issues from vulnerabilities.  project_key stringRequired for vulnerability issues Key of the project to use when creating issues from vulnerabilities.This parameter is required if using the integration to create Jira issues from vulnerabilities.  customize_jira_issue_enabled boolean When set to true, opens a prefilled form on the Jira instancewhen creating a Jira issue from a vulnerability.  jira_check_enabled boolean Verify Jira issues referenced in commit messages exist before allowing the push.  jira_exists_check_enabled boolean Verify the Jira issues referenced in commit messages exist in Jira.  jira_assignee_check_enabled boolean Verify the committer is the assignee of the Jira issues referenced in commit messages.  jira_status_check_enabled boolean Verify the status of Jira issues referenced in commit messages.  jira_allowed_statuses_as_string string Comma-separated list of allowed Jira issue statuses.  comment_on_event_enabled boolean Enable comments inside Jira issues on each GitLab event (commit / merge request)  commit_events boolean Trigger event when a commit is created or updated.  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for jira-cloud-app  jira_cloud_app_service_ids string Copy and paste your JSM Service ID here. Use comma (,) to separate multiple IDs.  jira_cloud_app_enable_deployment_gating boolean Enable to approve or reject blocked GitLab deployments from Jira Service Management.  jira_cloud_app_deployment_gating_environments string Enter the environment (production,staging,testing,development) where you want to enable deployment gating. Use comma (,) to separate multiple environments.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for linear  workspace_url stringRequired Linear workspace URL (for example, https://linear.app/example)  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for matrix  hostname string Custom hostname of the Matrix server. The default value is https://matrix-client.matrix.org.  token stringRequired The Matrix access token (for example, syt-zyx57W2v1u123ew11).  room stringRequired Unique identifier for the target room (in the format !qPKKM111FFKKsfoCVy:matrix.org).  notify_only_broken_pipelines boolean Send notifications for broken pipelines.  notify_only_when_pipeline_status_changes boolean Send notifications only when the pipeline status changes.  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  push_events boolean Trigger event for pushes to the repository.  issues_events boolean Trigger event when a work item is created, updated, or closed.  confidential_issues_events boolean Trigger event when a confidential work item is created, updated, or closed.  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  note_events boolean Trigger event for new comments.  confidential_note_events boolean Trigger event for new comments on confidential work items.  tag_push_events boolean Trigger event for new tags pushed to the repository.  pipeline_events boolean Trigger event when a pipeline status changes.  wiki_page_events boolean Trigger event when a wiki page is created or updated.  incident_events boolean Trigger event when an incident is created.  work_item_events boolean  confidential_work_item_events boolean  vulnerability_events boolean  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for mattermost  webhook stringRequired Mattermost notifications webhook (for example, http://mattermost.example.com/hooks/...).  username string Mattermost notifications username.  channel string Default channel to use if no other channel is configured.  notify_only_broken_pipelines boolean Send notifications for broken pipelines.  notify_only_when_pipeline_status_changes boolean Send notifications only when the pipeline status changes.  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  labels_to_be_notified string Labels to send notifications for. Leave blank to receive notifications for all events.  labels_to_be_notified_behavior string Labels to be notified for. Valid options are match_any and match_all. The default value is match_any.  push_channel string The name of the channel to receive push_events notifications  issue_channel string The name of the channel to receive issues_events notifications  incident_channel string The name of the channel to receive incident_events notifications  alert_channel string The name of the channel to receive alert_events notifications  confidential_issue_channel string The name of the channel to receive confidential_issues_events notifications  merge_request_channel string The name of the channel to receive merge_requests_events notifications  note_channel string The name of the channel to receive note_events notifications  confidential_note_channel string The name of the channel to receive confidential_note_events notifications  tag_push_channel string The name of the channel to receive tag_push_events notifications  deployment_channel string The name of the channel to receive deployment_events notifications  pipeline_channel string The name of the channel to receive pipeline_events notifications  wiki_page_channel string The name of the channel to receive wiki_page_events notifications  vulnerability_channel string The name of the channel to receive vulnerability_events notifications  push_events boolean Trigger event for pushes to the repository.  issues_events boolean Trigger event when a work item is created, updated, or closed.  confidential_issues_events boolean Trigger event when a confidential work item is created, updated, or closed.  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  note_events boolean Trigger event for new comments.  confidential_note_events boolean Trigger event for new comments on confidential work items.  tag_push_events boolean Trigger event for new tags pushed to the repository.  pipeline_events boolean Trigger event when a pipeline status changes.  wiki_page_events boolean Trigger event when a wiki page is created or updated.  deployment_events boolean Trigger event when a deployment starts or finishes.  incident_events boolean Trigger event when an incident is created.  work_item_events boolean  confidential_work_item_events boolean  vulnerability_events boolean  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for mattermost-slash-commands  token stringRequired The Mattermost token.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for microsoft-teams  webhook stringRequired The Microsoft Teams webhook (for example, https://outlook.office.com/webhook/...).  notify_only_broken_pipelines boolean Send notifications for broken pipelines.  notify_only_when_pipeline_status_changes boolean Send notifications only when the pipeline status changes.  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  push_events boolean Trigger event for pushes to the repository.  issues_events boolean Trigger event when a work item is created, updated, or closed.  confidential_issues_events boolean Trigger event when a confidential work item is created, updated, or closed.  work_item_events boolean  confidential_work_item_events boolean  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  note_events boolean Trigger event for new comments.  confidential_note_events boolean Trigger event for new comments on confidential work items.  tag_push_events boolean Trigger event for new tags pushed to the repository.  pipeline_events boolean Trigger event when a pipeline status changes.  wiki_page_events boolean Trigger event when a wiki page is created or updated.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for mock-ci  enable_ssl_verification boolean Enable SSL verification. Defaults to true (enabled).  mock_service_url stringRequired URL of the Mock CI integration.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for mock-monitoring  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for packagist  username stringRequired Username of a Packagist account.  token stringRequired API token of the Packagist server.  server string URL of the Packagist server. The default value is https://packagist.org.  push_events boolean Trigger event for pushes to the repository.  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  tag_push_events boolean Trigger event for new tags pushed to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for phorge  project_url stringRequired URL of the project.  issues_url stringRequired URL of the issue.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for pipelines-email  recipients stringRequired Comma-separated list of recipient email addresses.  notify_only_broken_pipelines boolean Send notifications for broken pipelines.  notify_only_when_pipeline_status_changes boolean Send notifications only when the pipeline status changes.  notify_only_default_branch boolean Send notifications for the default branch.  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  notify_child_pipelines boolean Send notifications for child pipelines.  pipeline_events boolean Trigger event when a pipeline status changes.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for pivotaltracker  token stringRequired The Pivotal Tracker token.  restrict_to_branch string Comma-separated list of branches to automatically inspect. Leave blank to include all branches.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for pumble  webhook stringRequired The Pumble webhook (for example, https://api.pumble.com/workspaces/x/...).  notify_only_broken_pipelines boolean Send notifications for broken pipelines.  notify_only_when_pipeline_status_changes boolean Send notifications only when the pipeline status changes.  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  push_events boolean Trigger event for pushes to the repository.  issues_events boolean Trigger event when a work item is created, updated, or closed.  confidential_issues_events boolean Trigger event when a confidential work item is created, updated, or closed.  work_item_events boolean  confidential_work_item_events boolean  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  note_events boolean Trigger event for new comments.  confidential_note_events boolean Trigger event for new comments on confidential work items.  tag_push_events boolean Trigger event for new tags pushed to the repository.  pipeline_events boolean Trigger event when a pipeline status changes.  wiki_page_events boolean Trigger event when a wiki page is created or updated.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for pushover  api_key stringRequired The application key.  user_key stringRequired The user key.  device string Leave blank for all active devices.  priority stringRequired The priority.  sound string The sound of the notification.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for redmine  project_url stringRequired URL of the project.  issues_url stringRequired URL of the issue.  new_issue_url stringRequired URL of the new issue.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for slack  webhook stringRequired Slack notifications webhook (for example, https://hooks.slack.com/services/...).  username string Slack notifications username.  channel string Default channel to use if no other channel is configured.  notify_only_broken_pipelines boolean Send notifications for broken pipelines.  notify_only_when_pipeline_status_changes boolean Send notifications only when the pipeline status changes.  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  labels_to_be_notified string Labels to send notifications for. Leave blank to receive notifications for all events.  labels_to_be_notified_behavior string Labels to be notified for. Valid options are match_any and match_all. The default value is match_any.  push_channel string The name of the channel to receive push_events notifications  issue_channel string The name of the channel to receive issues_events notifications  incident_channel string The name of the channel to receive incident_events notifications  alert_channel string The name of the channel to receive alert_events notifications  confidential_issue_channel string The name of the channel to receive confidential_issues_events notifications  merge_request_channel string The name of the channel to receive merge_requests_events notifications  note_channel string The name of the channel to receive note_events notifications  confidential_note_channel string The name of the channel to receive confidential_note_events notifications  tag_push_channel string The name of the channel to receive tag_push_events notifications  deployment_channel string The name of the channel to receive deployment_events notifications  pipeline_channel string The name of the channel to receive pipeline_events notifications  wiki_page_channel string The name of the channel to receive wiki_page_events notifications  vulnerability_channel string The name of the channel to receive vulnerability_events notifications  push_events boolean Trigger event for pushes to the repository.  issues_events boolean Trigger event when a work item is created, updated, or closed.  confidential_issues_events boolean Trigger event when a confidential work item is created, updated, or closed.  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  note_events boolean Trigger event for new comments.  confidential_note_events boolean Trigger event for new comments on confidential work items.  tag_push_events boolean Trigger event for new tags pushed to the repository.  pipeline_events boolean Trigger event when a pipeline status changes.  wiki_page_events boolean Trigger event when a wiki page is created or updated.  deployment_events boolean Trigger event when a deployment starts or finishes.  incident_events boolean Trigger event when an incident is created.  work_item_events boolean  confidential_work_item_events boolean  vulnerability_events boolean  alert_events boolean Trigger event when a new, unique alert is recorded.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for squash-tm  url stringRequired URL of the Squash TM webhook.  token string Secret token.  issues_events boolean Trigger event when a work item is created, updated, or closed.  confidential_issues_events boolean Trigger event when a confidential work item is created, updated, or closed.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for teamcity  enable_ssl_verification boolean Enable SSL verification. Defaults to true (enabled).  teamcity_url stringRequired TeamCity root URL (for example, https://teamcity.example.com).  build_type stringRequired The build configuration ID of the TeamCity project.  username stringRequired A user with permissions to trigger a manual build.  password stringRequired The password of the user.  push_events boolean Trigger event for pushes to the repository.  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for telegram  hostname string Custom hostname of the Telegram API. The default value is https://api.telegram.org.  token stringRequired The Telegram bot token (for example, 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11).  room stringRequired Unique identifier for the target chat or the username of the target channel (in the format @channelusername).  thread string Unique identifier for the target message thread (topic in a forum supergroup).  notify_only_broken_pipelines boolean Send notifications for broken pipelines.  notify_only_when_pipeline_status_changes boolean Send notifications only when the pipeline status changes.  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  push_events boolean Trigger event for pushes to the repository.  issues_events boolean Trigger event when a work item is created, updated, or closed.  confidential_issues_events boolean Trigger event when a confidential work item is created, updated, or closed.  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  note_events boolean Trigger event for new comments.  confidential_note_events boolean Trigger event for new comments on confidential work items.  tag_push_events boolean Trigger event for new tags pushed to the repository.  pipeline_events boolean Trigger event when a pipeline status changes.  wiki_page_events boolean Trigger event when a wiki page is created or updated.  incident_events boolean Trigger event when an incident is created.  work_item_events boolean  confidential_work_item_events boolean  vulnerability_events boolean  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for unify-circuit  webhook stringRequired The Unify Circuit webhook (for example, https://circuit.com/rest/v2/webhooks/incoming/...).  notify_only_broken_pipelines boolean Send notifications for broken pipelines.  notify_only_when_pipeline_status_changes boolean Send notifications only when the pipeline status changes.  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  push_events boolean Trigger event for pushes to the repository.  issues_events boolean Trigger event when a work item is created, updated, or closed.  confidential_issues_events boolean Trigger event when a confidential work item is created, updated, or closed.  work_item_events boolean  confidential_work_item_events boolean  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  note_events boolean Trigger event for new comments.  confidential_note_events boolean Trigger event for new comments on confidential work items.  tag_push_events boolean Trigger event for new tags pushed to the repository.  pipeline_events boolean Trigger event when a pipeline status changes.  wiki_page_events boolean Trigger event when a wiki page is created or updated.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for webex-teams  webhook stringRequired The Webex Teams webhook. For example, https://api.ciscospark.com/v1/webhooks/incoming/...  notify_only_broken_pipelines boolean Send notifications for broken pipelines.  notify_only_when_pipeline_status_changes boolean Send notifications only when the pipeline status changes.  branches_to_be_notified string Branches to send notifications for. Valid options are all, default, protected, and default_and_protected. The default value is default.  push_events boolean Trigger event for pushes to the repository.  issues_events boolean Trigger event when a work item is created, updated, or closed.  confidential_issues_events boolean Trigger event when a confidential work item is created, updated, or closed.  work_item_events boolean  confidential_work_item_events boolean  merge_requests_events boolean Trigger event when a merge request is created, updated, or merged.  note_events boolean Trigger event for new comments.  confidential_note_events boolean Trigger event for new comments on confidential work items.  tag_push_events boolean Trigger event for new tags pushed to the repository.  pipeline_events boolean Trigger event when a pipeline status changes.  wiki_page_events boolean Trigger event when a wiki page is created or updated.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for youtrack  project_url stringRequired URL of the project.  issues_url stringRequired URL of the issue.  push_events boolean Trigger event for pushes to the repository.  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false. Accepted fields for zentao  url stringRequired Base URL of the ZenTao instance.  api_url string If different from Web URL.  api_token stringRequired  zentao_product_xid stringRequired  use_inherited_settings boolean Indicates whether to inherit the default settings. Defaults to false.  force_secret_update boolean Force a write to rotate declared write-only integration secrets when no readable field drifted. Default: false  state string Can be one of: present, absent. Default: present. absent disables the integration.	Example: integrations: slack: webhook: "{{ vault_slack_webhook }}" username: gitlab jira: state: absent ...
groups[].approvals.settings object  Group-level merge request approval settings, mirroring the project form documented in Project Settings. Properties of groups[].approvals.settings  allow_author_approval boolean  allow_committer_approval boolean  allow_overrides_to_approver_list_per_merge_request boolean  require_password_to_approve boolean  require_reauthentication_to_approve boolean  retain_approvals_on_push boolean  selective_code_owner_removals boolean	Example: gitlab_settings_groups: - path: platform approvals: settings: allow_author_approval: false ...
projects[].pages object  Project Pages settings via PATCH. GitLab uses different names for several request and GET response fields; the request names below map to their corresponding response fields for comparison. Domains are documented separately in Environments and Deployments. Properties of projects[].pages  pages_unique_domain_enabled boolean Enable GitLab's unique-domain behavior.  pages_https_only boolean Require HTTPS for the Pages deployment.  pages_primary_domain string Primary Pages domain.  state string Can be one of: present, absent. Default: present. absent removes the Pages deployment.	Example: projects: - path: platform/service pages: pages_unique_domain_enabled: true ...
projects[].error_tracking object  Project error-tracking settings. Properties of projects[].error_tracking  active booleanRequired Enable or disable error tracking.  integrated boolean Use GitLab-integrated error tracking.	Example: projects: - path: platform/service error_tracking: active: true integrated: true ...
projects[].job_token_scope.enabled boolean  Toggles CI/CD job token access restriction (GitLab's inbound_enabled). The allowlists are documented in Access Management.	Example: projects: - path: platform/service job_token_scope: enabled: true ...