GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves details of a specific project hook in GitLab by its project ID and hook ID. It is useful for scenarios where you need to fetch configuration or status information about a webhook set up on a GitLab project, such as for monitoring or auditing purposes.

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 check its status or URL.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Select the authentication method, defaulting to GitLab API key authentication.
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 for the API path, including the project ID 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 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

  • Requires GitLab API key authentication unless Skip Authentication is enabled.

Troubleshooting

  • Ensure the project ID and hook ID are correctly provided and URL-encoded if necessary.
  • Authentication errors may occur if the API key is missing or invalid; verify credentials.
  • HTTP method should be GET for this operation; using other methods may cause errors.
  • Check the base URL to ensure it points to the correct GitLab instance.

Links

Discussion