GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves events related to a specific project from the GitLab API (v4). It is useful for monitoring project activities such as issues, merge requests, notes, and other event types. For example, it can be used to fetch recent events for a project to track changes or user actions.

Use Case Examples

  1. Fetch all events for a project by its ID.
  2. Filter project events by action type or target type (e.g., issues or merge requests).
  3. Retrieve events created before or after a specific date.
  4. Paginate through project events with page and per_page parameters.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to connect to, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines the parameters for the API call including project ID (path), and optional query filters like action, target_type, before, after, sort, page, and per_page.
Query Parameters Collection of optional query parameters to filter and paginate the events, such as action, target_type, before, after, sort, page, and per_page.
Path Parameters Collection containing the project ID used in the API path to specify which project's events to retrieve.

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 (e.g., issue, merge_request).
  • author - Information about the user who triggered the event.
  • created_at - Timestamp when the event was created.
  • project_id - ID of the project associated with the event.
  • details - Additional details about the event, if available.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID is correctly provided and URL-encoded if necessary to avoid 404 errors.
  • Verify that the API key credential has sufficient permissions to access project events to prevent authorization errors.
  • Check the baseUrl if connecting to a self-hosted GitLab instance to avoid connection failures.
  • Validate date formats for 'before' and 'after' query parameters to prevent request errors.

Links

Discussion