GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node interacts with the GitLab API to post broadcast messages using the /api/v4/broadcast_messages endpoint. It is useful for automating the creation and management of broadcast messages in GitLab, such as announcements or alerts to all users in a GitLab instance.

Use Case Examples

  1. Automatically post a broadcast message to notify all users about scheduled maintenance.
  2. Create broadcast messages programmatically based on external triggers or events.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Select the authentication method to use for the request, hidden if Skip Authentication is true.
baseUrl Base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Schema defining the parameters for the postApiV4BroadcastMessages operation, required in the request body.
Request Body Schema Schema defining the structure of the request body for the postApiV4BroadcastMessages operation.
Request Path API endpoint path for posting broadcast messages, fixed to /api/v4/broadcast_messages.

Output

JSON

  • id - Unique identifier of the created broadcast message.
  • message - Content of the broadcast message.
  • starts_at - Start time of the broadcast message visibility.
  • ends_at - End time of the broadcast message visibility.
  • color - Color code associated with the broadcast message.
  • broadcast_type - Type/category of the broadcast message.
  • active - Indicates if the broadcast message is currently active.

Dependencies

  • GitLab API credentials

Troubleshooting

  • Ensure the GitLab API credentials are correctly configured and have the necessary permissions to post broadcast messages.
  • Verify the baseUrl is correct and accessible from the n8n environment.
  • Check that the request body conforms to the expected schema for the postApiV4BroadcastMessages operation to avoid validation errors.
  • If skipping authentication, confirm that the endpoint supports unauthenticated requests, otherwise authentication errors will occur.

Links

Discussion