Voltage icon

Voltage

Interact with Voltage API
Join our community

Actions18

Overview

This node integrates with the Voltage API to manage webhooks within an organization. Specifically, the Update Webhook operation allows users to modify an existing webhook's properties such as its URL, description, and subscribed event types.

Typical use cases include:

  • Changing the destination URL where webhook events are sent.
  • Updating the description for better identification or documentation.
  • Adjusting which event types the webhook listens to, e.g., subscribing to new event categories or unsubscribing from others.

For example, if a user wants to redirect webhook notifications to a new endpoint after migrating their backend service, they can update the webhook URL using this node. Similarly, if they want to start receiving additional event types like "Send - Failed" or stop receiving "Test - Event", they can update the event subscriptions accordingly.

Properties

Name Meaning
Organization ID The unique identifier of the organization owning the webhook.
Webhook ID The unique identifier of the webhook to update.
Webhook Description A textual description of the webhook, useful for documentation or identification purposes.
Event Types The list of event types to subscribe to. Options include:
- Send - Created
- Send - Succeeded
- Send - Failed
- Receive - Created
- Receive - Paid
- Receive - Expired
- Test - Event

Output

The node outputs JSON data representing the updated webhook object returned by the Voltage API. This typically includes details such as the webhook's ID, URL, description, subscribed event types, status, and metadata related to the webhook configuration.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Voltage API.
  • The node uses the official Voltage API SDK client internally.
  • Proper configuration of the API base URL and timeout settings is required via credentials.
  • The organization ID must be valid and correspond to an existing organization in Voltage.

Troubleshooting

Common Issues

  • Invalid API Key or Credentials: If authentication fails, the node will throw an error indicating an authentication issue. Verify that the API key is correct and has sufficient permissions.
  • Webhook Not Found: If the specified webhook ID does not exist under the given organization, a "Not Found (404)" error will occur.
  • Validation Errors: Providing invalid or incomplete data (e.g., empty webhook ID or malformed event types) will result in a validation error (422).
  • Permission Denied: Insufficient permissions on the API key may cause a 403 error.
  • Server Errors: Temporary issues with the Voltage API server may cause 5xx errors.

Error Messages and Resolutions

Error Message Cause Resolution
Validation Error (422): The request data is invalid. Please check your parameters. Invalid input data Review and correct the input parameters, especially webhook ID, URL, and event types.
Authentication Error (401): Invalid API key or credentials. Incorrect or expired API key Verify and update the API key credential used by the node.
Permission Error (403): Access denied. Check your API key permissions. API key lacks necessary permissions Ensure the API key has rights to update webhooks in the organization.
Not Found (404): Organization, environment, or resource not found. Non-existent organization or webhook ID Confirm the organization ID and webhook ID are correct and exist in Voltage.
Server Error (5xx): The Voltage API is experiencing issues. Voltage API server problems Retry later or contact Voltage support if the problem persists.
API returned non-JSON response (Status: ...). Check your API credentials and organization ID. Possible authentication or configuration issue Double-check API credentials and organization ID; ensure network connectivity.

Links and References

Discussion