GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows posting broadcast messages to a GitLab instance via the GitLab API. It is useful for automating the creation and sending of broadcast messages to users or groups within a GitLab environment, such as announcements or alerts.

Use Case Examples

  1. Automatically send a broadcast message to all users when a new feature is deployed.
  2. Schedule regular broadcast messages for maintenance notifications.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process for the API request.
Authentication Specifies the authentication method to use, hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the broadcast message will be posted.
Method HTTP method to use for the request, default is GET but POST is used for this operation.
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 operation.
Request Path The API endpoint path for posting broadcast messages, fixed to /api/v4/broadcast_messages.

Output

JSON

  • id - Unique identifier of the broadcast message.
  • message - Content of the broadcast message.
  • starts_at - Start time when the broadcast message becomes active.
  • ends_at - End time when the broadcast message expires.
  • created_at - Timestamp when the broadcast message was created.
  • updated_at - Timestamp when the broadcast message was last updated.
  • broadcast_type - Type/category of the broadcast message.
  • color - Color code associated with the broadcast message for UI display.
  • active - Boolean indicating if the broadcast message is currently active.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the baseUrl is correctly set to the target GitLab instance URL to avoid connection errors.
  • If authentication is enabled, verify that the GitLab API credentials are valid and have sufficient permissions to post broadcast messages.
  • Check that the request body conforms to the required schema for posting broadcast messages to avoid validation errors.
  • Common error messages may include authentication failures, permission denied, or invalid request body format. Resolving these typically involves correcting credentials, permissions, or request data format.

Links

Discussion