GitLab API icon

GitLab API

Gitlab

Actions917

Overview

This node operation updates the Campfire integration settings for a specific GitLab project using the GitLab API. It is useful for automating the configuration of project integrations, particularly for teams using Campfire for chat and notifications within their GitLab projects. For example, a user can update the Campfire integration to change notification settings or credentials programmatically.

Use Case Examples

  1. Updating Campfire integration settings for a GitLab project to enable or disable notifications.
  2. Automating the configuration of multiple projects' Campfire integrations in a CI/CD pipeline.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, 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 API request, defaulting to PUT for this operation.
Path Parameters The path parameters for the API request, specifically the project ID to identify which project's Campfire integration to update.

Output

JSON

  • id - The ID of the GitLab project.
  • integration_status - The status of the Campfire integration after the update.
  • integration_settings - The updated settings of the Campfire integration for the project.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and the project exists in GitLab.
  • Verify that the API key used for authentication has sufficient permissions to update project integrations.
  • Check the request body schema to ensure all required fields for the Campfire integration update are correctly provided.
  • Common error messages include 401 Unauthorized (due to invalid or missing API key), 404 Not Found (if the project ID is incorrect), and 400 Bad Request (if the request body is malformed). Resolving these involves correcting credentials, verifying project existence, and validating request payloads.

Links

Discussion