GitLab API

GitlabTool

Actions905

Overview

This node interacts with the GitLab API to retrieve event data using the API v4 endpoint. It is useful for scenarios where users want to fetch and filter GitLab events such as project activities, user actions, or system events. For example, it can be used to monitor project updates, track user activities, or generate reports based on event data.

Use Case Examples

  1. Fetching all events across a user's projects with pagination.
  2. Filtering events by action type or target type, such as only merge request events.
  3. Retrieving events created before or after a specific date to analyze recent activities.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API requests are sent.
Method HTTP method used for the API request, default is GET.
Query Parameters Collection of optional query parameters to filter and paginate the events retrieved from the API.

Output

JSON

  • id - Unique identifier of the event.
  • action_name - Name of the action performed in the event.
  • target_type - Type of the target object related to the event.
  • author_id - Identifier of the user who triggered the event.
  • created_at - Timestamp when the event was created.
  • project_id - Identifier of the project related to the event.
  • push_data - Additional data related to push events, if applicable.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access events.
  • Verify the base URL is correct and accessible, especially if using a self-hosted GitLab instance.
  • Check query parameters for correct data types and valid values to avoid API errors.
  • Common error messages include authentication failures (401 Unauthorized) and invalid parameter errors (400 Bad Request). Resolving these involves verifying credentials and parameter formats.

Links

Discussion