GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves events for a specific webhook of a project in GitLab using the GitLab API v4. It is useful for monitoring webhook events related to a project, such as push events, merge requests, or other GitLab activities. For example, it can be used to automate workflows based on webhook event data or to audit webhook activity for a project.

Use Case Examples

  1. Fetch webhook events for a project to trigger notifications or further automation.
  2. Audit webhook events to analyze project activity or troubleshoot webhook issues.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key or token.
baseUrl The base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, default is GET.
Parameter Schema Defines the query and path parameters for the API request, including status filters, pagination, and required project and hook IDs.
Query Parameters Optional query parameters to filter the webhook events, including status codes, items per page, and page number.
Path Parameters Required path parameters specifying the project ID and webhook ID to identify the webhook whose events are being retrieved.

Output

JSON

  • events - Array of webhook event objects returned from the GitLab API for the specified project webhook.

Dependencies

  • GitLab API authentication token or API key

Troubleshooting

  • Ensure the project ID and webhook ID path parameters are correctly set and correspond to existing resources in GitLab.
  • Verify that the authentication token or API key has sufficient permissions to access the project and webhook events.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • If pagination parameters (per_page, page) are used, ensure they are within allowed ranges to avoid errors.

Links

Discussion