GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation updates a custom header for a specific hook in GitLab via the GitLab API. It is useful for managing webhook configurations by modifying custom headers associated with a hook, which can be essential for authentication, routing, or other custom behaviors in webhook handling.

Use Case Examples

  1. Updating a custom header key-value pair for a webhook hook in GitLab to change how the webhook request is processed.
  2. Modifying authentication or custom metadata headers for a specific GitLab hook to integrate with external systems.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, default is GET but can be set to PUT for this operation.
Path Parameters Parameters used in the API request path to specify the hook ID and the custom header key to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the custom header for the specified hook.

Dependencies

  • GitLab API credentials

Troubleshooting

  • Ensure the hook_id and key path parameters are correctly set and valid; otherwise, the API request will fail.
  • Authentication errors may occur if the GitLab API credentials are missing or invalid; verify credentials are properly configured.
  • The API endpoint path must be correctly formatted as /api/v4/hooks/{hook_id}/custom_headers/{key} to avoid 404 errors.

Links

Discussion