GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 for monitoring or managing webhook configurations.

Use Case Examples

  1. Fetch details of a system hook by providing its hook ID to verify its configuration or status.
  2. Use in automation workflows to dynamically retrieve system hook information for auditing or integration purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to GET. Options include GET, POST, PUT, DELETE, HEAD, PATCH.
Path Parameters Parameters included in the request path, specifically the hook_id which identifies the system hook to retrieve.

Output

JSON

  • id - The 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.
  • push_events - Boolean indicating if push events trigger the hook.
  • tag_push_events - Boolean indicating if tag push events trigger the hook.
  • merge_requests_events - Boolean indicating if merge request events trigger the hook.
  • repository_update_events - Boolean indicating if repository update events trigger the hook.
  • enable_ssl_verification - Boolean indicating if SSL verification is enabled for the hook.

Dependencies

  • GitLab API credentials

Troubleshooting

  • Ensure the hook_id path parameter is provided and valid; missing or incorrect IDs will cause errors.
  • Verify that the baseUrl is correct and accessible; incorrect URLs will lead to connection failures.
  • If authentication is enabled, ensure valid GitLab API credentials are configured; authentication failures will prevent data retrieval.
  • Check the HTTP method is set appropriately; GET is typical for this operation, but other methods may cause unexpected behavior.

Links

Discussion