Forgejo icon

Forgejo

Interact with Forgejo API
Join our community

Actions73

Overview

This node operation updates an existing webhook in a Forgejo repository. It allows users to modify the webhook's URL, the events that trigger the webhook, and its active status. This is useful for maintaining and managing webhook configurations to ensure they send payloads to the correct endpoint and respond to the desired repository events.

Use Case Examples

  1. Updating a webhook URL to a new endpoint after a server migration.
  2. Changing the events that trigger the webhook to include or exclude certain repository activities like push or pull request events.
  3. Activating or deactivating a webhook without deleting it, for temporary suspension.

Properties

Name Meaning
Owner The username or organization that owns the repository where the webhook exists.
Repository The name of the repository where the webhook is configured.
Webhook ID The unique identifier of the webhook to update.
Webhook URL The new URL to which the webhook payloads will be sent.
Events The list of repository events that will trigger the webhook.
Active Whether the webhook is active and should send payloads.

Output

JSON

  • json
    • id - The ID of the updated webhook.
    • type - The type of the webhook, typically 'forgejo'.
    • config
      * url - The URL configured for the webhook.
    • events - The list of events that trigger the webhook.
    • active - Indicates if the webhook is active.

Dependencies

  • Requires an API key credential for Forgejo API authentication.

Troubleshooting

  • Ensure the provided webhook ID exists in the specified repository; otherwise, the update will fail with a not found error.
  • Verify that the webhook URL is a valid and reachable URL to avoid webhook delivery failures.
  • Check that the API credentials have sufficient permissions to update webhooks in the repository.
  • If the node throws authentication errors, verify the API key or token used for Forgejo API authentication is correct and has not expired.

Links

Discussion