GitLab API

GitlabTool

Actions1000

Overview

This node operation updates the Hangouts Chat integration settings for a specific GitLab group by sending a PUT request to the GitLab API endpoint `/api/v4/groups/{id}/integrations/hangouts-chat`. It is useful for managing and configuring Hangouts Chat notifications and integrations within GitLab groups programmatically.

Use Case Examples

  1. Updating Hangouts Chat integration settings for a GitLab group to customize notifications or integration behavior.
  2. Automating the configuration of group integrations in GitLab as part of a CI/CD pipeline or administrative workflow.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the 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 request is sent, defaulting to https://gitlab.com.
Method HTTP method to use for the request, defaulting to PUT.
Path Parameters Parameters to be included in the request path, specifically the group ID (`id`) to identify which group's Hangouts Chat integration to update.

Output

JSON

  • id - The ID of the GitLab group for which the integration is updated.
  • integration_status - Status of the Hangouts Chat integration after the update.
  • webhook_url - The webhook URL configured for the Hangouts Chat integration.
  • updated_at - Timestamp indicating when the integration was last updated.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID (`id`) path parameter is correctly provided and corresponds to an existing GitLab group.
  • Verify that the API key credential used for authentication has sufficient permissions to update group integrations.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include 401 Unauthorized (due to invalid or missing API key), 404 Not Found (if the group ID does not exist), and 400 Bad Request (if the request body schema is invalid). Resolving these involves correcting authentication credentials, verifying group existence, and ensuring request body correctness.

Links

Discussion