GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to retrieve system hooks via the API v4 endpoint. It is useful for automating workflows that require monitoring or managing GitLab system hooks, such as integrating GitLab events with other systems or services. For example, it can be used to fetch a list of system hooks to audit or trigger actions based on GitLab events.

Use Case Examples

  1. Fetch system hooks from a GitLab instance to monitor webhook configurations.
  2. Automate the retrieval of system hooks for auditing or integration purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making 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 requests are sent.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Optional query parameters to control pagination of the system hooks list, including 'page' for the current page number and 'per_page' for the number of items per page.

Output

JSON

  • id - Unique identifier of the system hook.
  • url - The URL configured for the system hook.
  • created_at - Timestamp when the system hook was created.
  • updated_at - Timestamp when the system hook was last updated.
  • enable_ssl_verification - Indicates if SSL verification is enabled for the hook.
  • push_events - Indicates if push events trigger the hook.
  • tag_push_events - Indicates if tag push events trigger the hook.
  • note_events - Indicates if note events trigger the hook.
  • merge_requests_events - Indicates if merge request events trigger the hook.
  • repository_update_events - Indicates if repository update events trigger the hook.
  • enable_wiki_page_events - Indicates if wiki page events trigger the hook.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access system hooks.
  • Verify the baseUrl is correct and accessible from the environment where the node runs.
  • Check pagination parameters 'page' and 'per_page' to avoid empty or incomplete results.
  • Common error messages include authentication failures (401 Unauthorized) and resource not found (404) if the API endpoint or base URL is incorrect.

Links

Discussion