GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves the list of hooks for a specific GitLab project using the GitLab API v4. It is useful for scenarios where you need to manage or monitor project webhooks, such as automating CI/CD pipelines, integrating with external services, or tracking project events.

Use Case Examples

  1. Fetch all webhooks configured for a GitLab project to audit or update them.
  2. Use the retrieved hooks to trigger notifications or other automated workflows based on project events.

Properties

Name Meaning
Skip Authentication Option to skip API authentication, useful for public or unauthenticated requests.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, default is GET.
Query Parameters Optional query parameters to control pagination of the hooks list, including page number and items per page.
Path Parameters Path parameters specifying the project ID or URL-encoded path to identify the project whose hooks are being retrieved.

Output

JSON

  • id - Unique identifier of the project hook
  • url - The URL configured for the webhook
  • project_id - ID of the project the hook belongs to
  • push_events - Boolean indicating if push events trigger the hook
  • issues_events - Boolean indicating if issue 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
  • created_at - Timestamp when the hook was created

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly specified in the path parameters to avoid 404 errors.
  • Verify that the API key credential has sufficient permissions to access project hooks to prevent authorization errors.
  • Check the base URL if using a self-hosted GitLab instance to ensure the API endpoint is reachable.
  • Pagination parameters (page and per_page) should be valid integers; invalid values may cause request failures.

Links

Discussion