GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation updates a system hook in GitLab by sending a PUT request to the GitLab API endpoint `/api/v4/hooks/{hook_id}`. It is useful for automating the management of system hooks, such as modifying webhook configurations for GitLab projects or groups. For example, it can be used to update the URL or events of a system hook programmatically.

Use Case Examples

  1. Updating a system hook's URL or events in GitLab to integrate with an external service.
  2. Automating the modification of system hooks as part of a CI/CD pipeline setup.

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 authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to PUT for this operation.
Path Parameters The path parameters for the request, specifically the `hook_id` which identifies the system hook to update.

Output

JSON

  • id - The unique identifier of the updated system hook.
  • url - The URL configured for the system hook.
  • created_at - Timestamp when the system hook was created.
  • updated_at - Timestamp when the system hook was last updated.
  • events - List of events that trigger the system hook.

Dependencies

  • GitLab API credentials for authentication

Troubleshooting

  • Ensure the `hook_id` path parameter is correctly provided and corresponds to an existing system hook in GitLab.
  • Verify that the API credentials have sufficient permissions to update system hooks.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 404 Not Found if the hook ID does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion