VoltageInstall

Overview

This node integrates with the Voltage API to manage webhooks within an organization. Specifically, the Webhook - Stop operation allows users to stop a running webhook by specifying its ID and the organization it belongs to. This is useful when you want to temporarily disable event notifications sent via a webhook without deleting it.

Common scenarios include:

• Pausing webhook event delivery during maintenance or troubleshooting.
• Temporarily disabling integrations that rely on webhook events.
• Managing webhook lifecycle programmatically as part of automation workflows.

Example: You have a webhook sending payment event notifications to your system. If you need to halt these notifications temporarily (e.g., for system upgrades), you can use this node operation to stop the webhook without deleting it.

Properties

Output

The output JSON contains the response from the Voltage API after attempting to stop the specified webhook. Typically, this will include details about the webhook's new status or confirmation that the webhook has been stopped.

Example output structure:

{
  "id": "webhook-id",
  "organization_id": "org-id",
  "status": "stopped",
  "url": "https://example.com/webhook",
  "event_types": ["send.created", "receive.paid"],
  "description": "Optional description"
}

If the operation fails, the output may contain an error object describing the failure.

Dependencies

• Requires an API key credential for authenticating with the Voltage API.
• The node uses the official Voltage API SDK client.
• Proper configuration of the API base URL and timeout settings is required in the credentials.
• The user must have appropriate permissions to manage webhooks within the specified organization.

Troubleshooting

• Authentication errors (401): Ensure the API key credential is valid and has permission to access the organization.
• Permission errors (403): Verify that the API key has rights to manage webhooks in the organization.
• Not found errors (404): Confirm that the organization ID and webhook ID are correct and exist.
• Validation errors (422): Check that all required parameters are provided and correctly formatted.
• Server errors (5xx): These indicate issues on the Voltage API side; retry later or contact support.
• Non-JSON response errors: Usually caused by incorrect credentials or organization ID; verify these inputs.

If the node is set to continue on fail, errors will be returned in the output JSON with detailed information.

Links and References

• Voltage API Documentation (for webhook management)
• Voltage API SDK GitHub Repository (for SDK usage details)