GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves the list of project hooks for a specified project in GitLab using the GitLab API v4. It is useful for users who want to programmatically access webhook configurations associated with a GitLab project, for example, to monitor or manage webhook integrations.

Use Case Examples

  1. Fetch all webhook hooks for a project by providing the project ID or URL-encoded path.
  2. Paginate through project hooks by specifying page number and items per page to handle large sets of hooks.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication Select the authentication method to use for the API request (hidden unless Skip Authentication is false).
baseUrl The base URL of the GitLab instance to which the API requests are sent.
Method The HTTP method to use for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Query Parameters Optional query parameters for pagination when retrieving project hooks.
Path Parameters Path parameters specifying the project identifier.

Output

JSON

  • ``
    • id - The unique identifier of each project hook.
    • url - The URL configured for the webhook.
    • created_at - Timestamp when the webhook was created.
    • push_events - Boolean indicating if push events trigger the webhook.
    • merge_requests_events - Boolean indicating if merge request events trigger the webhook.
    • tag_push_events - Boolean indicating if tag push events trigger the webhook.
    • note_events - Boolean indicating if note events trigger the webhook.
    • enable_ssl_verification - Boolean indicating if SSL verification is enabled for the webhook.

Dependencies

  • Requires GitLab API credentials for authentication unless Skip Authentication is enabled.

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly specified; otherwise, the API will return an error indicating the project was not found.
  • If authentication is enabled, verify that the GitLab API credentials are valid and have sufficient permissions to access project hooks.
  • Pagination parameters (page and per_page) should be valid integers; invalid values may cause the API to return errors or unexpected results.

Links

Discussion