GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows updating the email integration settings for pipeline notifications in a specific GitLab project. It is useful for automating the configuration of pipeline email notifications in GitLab projects, such as setting or modifying the email address that receives pipeline status updates.

Use Case Examples

  1. Automatically update the pipeline email integration for a GitLab project when project settings change.
  2. Configure pipeline email notifications for multiple projects in bulk via automation workflows.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, defaulting to GitLab API authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET. Options include GET, POST, PUT, DELETE, HEAD, PATCH.
Path Parameters The path parameters for the request, specifically the project ID (id) which is required to identify the GitLab project for which the pipeline email integration is being updated.

Output

JSON

  • id - The ID of the GitLab project for which the pipeline email integration was updated.
  • email - The email address configured for pipeline notifications.
  • notify_only_broken_pipelines - Flag indicating if notifications are sent only for broken pipelines.
  • notify_only_default_branch - Flag indicating if notifications are sent only for the default branch.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID (id) path parameter is correctly provided and corresponds to an existing GitLab project.
  • Verify that the authentication credentials are valid and have sufficient permissions to update project integrations.
  • Check that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab server.
  • Common error messages may include 401 Unauthorized (invalid credentials), 404 Not Found (project ID does not exist), or 400 Bad Request (invalid request body).

Discussion