GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 auditing purposes.

Use Case Examples

  1. Fetch details of a system hook by providing its unique hook ID to understand its configuration and status.
  2. Use in automation workflows to verify system hook settings before performing further actions.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use if authentication is not skipped.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request.
Parameter Schema Defines the path parameter 'hook_id' which is the ID of the system hook to retrieve.
Request Body Schema Schema for the request body, not used in this GET operation.
Request Path The API endpoint path with a placeholder for the hook ID.
Path Parameters Collection of path parameters including 'hook_id' which specifies the system hook ID to fetch.

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.
  • enable_ssl_verification - Indicates if SSL verification is enabled for the hook.

Dependencies

  • GitLab API credentials for authentication

Troubleshooting

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

Links

Discussion