GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation deletes a specific system hook in GitLab by its hook ID. It is useful for managing and cleaning up system hooks that are no longer needed or valid in a GitLab instance. For example, if a system hook was created for a project or group and is no longer required, this operation can remove it to prevent unnecessary webhook calls.

Use Case Examples

  1. Deleting a system hook by providing its hook ID to stop receiving webhook events from GitLab.
  2. Automating the cleanup of system hooks in GitLab as part of a DevOps workflow.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is GET but DELETE is used for this operation.
Path Parameters The path parameter containing the hook ID to specify which system hook to delete.

Output

JSON

  • statusCode - The HTTP status code returned from the delete operation, indicating success or failure.
  • responseBody - The body of the response from GitLab after attempting to delete the system hook, typically empty on success.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the hook_id path parameter is correctly provided and valid; an invalid or missing hook_id will cause the request to fail.
  • Authentication errors may occur if the API token is missing, expired, or lacks permissions to delete system hooks.
  • Network or baseUrl misconfiguration can lead to connection failures; verify the baseUrl is correct for your GitLab instance.

Links

Discussion