GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation updates a specific project hook in a GitLab project using the GitLab API. It is useful for managing webhook configurations on GitLab projects, such as modifying the URL or events that trigger the webhook. For example, a user can update the webhook URL or change which events trigger the webhook for a project.

Use Case Examples

  1. Updating a webhook URL for a GitLab project to a new endpoint.
  2. Changing the events that trigger a project webhook to include push events and merge requests.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication The authentication method used for the request, 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 can be set to PUT for this operation.
Path Parameters Parameters for the request path including the project ID and the hook ID to identify which project hook to update.

Output

JSON

  • id - The ID of the updated project hook.
  • url - The URL of the webhook.
  • project_id - The ID of the project the hook belongs to.
  • push_events - Boolean indicating if push events trigger the webhook.
  • merge_requests_events - Boolean indicating if merge request events trigger the webhook.
  • tag_push_events - Boolean indicating if tag push events trigger the webhook.
  • note_events - Boolean indicating if note events trigger the webhook.
  • enable_ssl_verification - Boolean indicating if SSL verification is enabled for the webhook.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and hook ID are correct and exist in GitLab to avoid 404 errors.
  • Verify that the API key used has sufficient permissions to update project hooks to avoid authorization errors.
  • Check the request body schema matches the expected format to prevent validation errors from the API.

Links

Discussion