GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves details of a specific project hook from a GitLab project using the GitLab API v4. It is useful for scenarios where you need to fetch configuration or status information about a webhook associated with a GitLab project, such as for monitoring or managing project integrations.

Use Case Examples

  1. Fetch details of a webhook for a project to verify its configuration.
  2. Retrieve information about a specific project hook to audit webhook settings.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated API access.
Authentication Select the authentication method, typically an API key credential for GitLab API.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Path Parameters Parameters to specify the project ID or URL-encoded path and the hook ID to identify the specific project hook.

Output

JSON

  • id - The unique identifier of the project hook.
  • url - The URL configured for the webhook.
  • created_at - Timestamp when the hook was created.
  • push_events - Boolean indicating if push events trigger the hook.
  • merge_requests_events - Boolean indicating if merge request events trigger the hook.
  • tag_push_events - Boolean indicating if tag push events trigger the hook.
  • note_events - Boolean indicating if note events trigger the hook.
  • enable_ssl_verification - Boolean indicating if SSL verification is enabled for the hook.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and hook ID are correct and exist in the GitLab instance.
  • Verify that the API token used has sufficient permissions to access project hooks.
  • If skipping authentication, confirm the GitLab instance allows unauthenticated access to project hooks.
  • Common error: 404 Not Found - The project or hook ID does not exist or is inaccessible.
  • Common error: 401 Unauthorized - Authentication failed or token lacks required scopes.

Links

Discussion