GitLab API icon

GitLab API

Gitlab

Actions1062

Projects → getApiV4ProjectsIdHooksHookIdEvents

AI-generated

Summary

Retrieve a list of events for a specific webhook on a given GitLab project by ID and hook ID.

Inputs

  • id (required) — The ID of the GitLab project from which to fetch webhook events.
  • hook_id (required) — The ID of the webhook hook on the project to fetch events for.
  • status — Filter events by HTTP status codes such as '200', '404', or categories like 'successful', 'client_failure', and 'server_failure'.
  • per_page — Number of events to return per page (max 20). Defaults to 20.
  • page — Page number to retrieve in pagination. Defaults to 1.
  • skipAuthentication — Optionally skip the use of authentication credentials.
  • baseUrl — Base URL of the GitLab instance; defaults to https://gitlab.com.
  • method — HTTP method to use; defaults to GET and typically stays this value when retrieving events.

Output shape

a JSON array of event objects representing webhook call events for the specified project hook, including details filtered per optional query parameters.

Pagination is supported via 'per_page' and 'page' query parameters, with a maximum of 20 items per page. Authentication is required by default. The response corresponds to the GitLab REST API endpoint '/api/v4/projects/{id}/hooks/{hook_id}/events'.

Links

Discussion