GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves details of a specific system hook from the GitLab API using the hook's ID. It is useful for scenarios where you need to fetch information about a particular system hook configured in a GitLab instance, such as monitoring or managing webhook configurations programmatically.

Use Case Examples

  1. Fetch details of a system hook by providing its unique hook ID to monitor webhook events in GitLab.
  2. Use the node to verify the configuration or status of a system hook before performing further automation tasks.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET.
Path Parameters Parameters included in the request path, specifically the hook_id identifying the system hook to retrieve.

Output

JSON

  • id - The unique identifier of the system hook.
  • url - The URL to which the system hook sends events.
  • created_at - Timestamp when the system hook was created.
  • updated_at - Timestamp when the system hook was last updated.
  • events - List of events that trigger the system hook.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the hook_id path parameter is provided and valid; missing or incorrect IDs will cause errors.
  • Authentication errors may occur if the API key credential is missing or invalid; verify credentials are correctly configured.
  • Network or baseUrl issues can cause request failures; confirm the baseUrl is correct and accessible.

Links

Discussion