GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation deletes a specific project hook in a GitLab project using the GitLab API. It is useful for managing project webhooks by removing those that are no longer needed or valid. For example, if a webhook was set up to notify an external service about project events but the service is no longer used, this operation can remove that webhook to keep the project configuration clean.

Use Case Examples

  1. Deleting a webhook from a GitLab project to stop notifications to an external service.
  2. Automating cleanup of project hooks during project decommissioning or migration.

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, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but should be set to DELETE for this operation.
Path Parameters Parameters required in the URL path to identify the project and the specific hook to delete.

Output

JSON

  • success - Indicates whether the hook deletion was successful.
  • statusCode - HTTP status code returned by the API.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and hook ID are correct and exist in the GitLab instance.
  • Verify that the API key used has sufficient permissions to delete project hooks.
  • If skipping authentication, the request will likely fail unless the GitLab instance allows unauthenticated access for this operation.

Links

Discussion