GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves details of a specific project hook in GitLab using the GitLab API. It is useful for scenarios where you need to fetch information about a particular webhook configured on a GitLab project, such as for monitoring or managing project integrations.

Use Case Examples

  1. Fetch details of a webhook by providing the project ID and the hook ID to verify its configuration or status.
  2. Use it to audit project hooks before making changes or deleting them.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication to use, defaulting to GitLab API key authentication.
baseUrl 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 for the API path, including project ID and hook ID to specify which project hook to retrieve.

Output

JSON

  • id - The unique identifier of the project hook.
  • url - The URL configured for the project hook.
  • created_at - Timestamp when the project 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 key credential

Troubleshooting

  • Ensure the project ID and hook ID are correct and exist in the GitLab instance to avoid 404 errors.
  • If authentication is required, verify that the GitLab API key credential is valid and has sufficient permissions.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 401 Unauthorized (invalid or missing API key) and 404 Not Found (invalid project or hook ID).

Links

Discussion