GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation updates the Mattermost integration settings for a specific GitLab group by sending a PUT request to the GitLab API endpoint `/api/v4/groups/{id}/integrations/mattermost`. It is useful for automating the configuration of Mattermost integrations within GitLab groups, such as enabling or modifying notifications and other integration parameters.

Use Case Examples

  1. Automate updating Mattermost integration settings for a GitLab group when group configurations change.
  2. Enable or disable Mattermost notifications for a GitLab group programmatically.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the request, default is GET but for this operation it is PUT.
Path Parameters The path parameters required for the API endpoint, specifically the group ID to identify which group's Mattermost integration to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the Mattermost integration for the specified group.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API key used for authentication has sufficient permissions to update group integrations.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • If skipping authentication, ensure the API endpoint allows unauthenticated requests, otherwise the request will fail.

Links

Discussion