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 Webhook - Start operation activates a previously created webhook, enabling it to begin receiving and processing events from the Voltage platform.

Common scenarios for using this node include:

  • Automating event-driven workflows by starting webhooks that listen for specific events such as payment updates or wallet changes.
  • Managing webhook lifecycle programmatically, e.g., creating, starting, stopping, and deleting webhooks as part of deployment or maintenance scripts.
  • Integrating Voltage event notifications into other systems via n8n workflows.

Example use case: After creating a webhook to monitor payment status changes, you can use this node to start the webhook so it begins sending event data to your specified URL.

Properties

Name Meaning
Organization ID The unique identifier of the organization under which the webhook exists.
Webhook ID The unique identifier of the webhook to start.

Output

The output is a JSON object representing the started webhook's current state as returned by the Voltage API. This typically includes details such as the webhook ID, URL, subscribed event types, status (now active), and metadata related to the webhook configuration.

The node does not output binary data.

Example output structure (simplified):

{
  "id": "string",
  "url": "string",
  "event_types": ["string"],
  "status": "active",
  "description": "string",
  "created_at": "string",
  "updated_at": "string"
}

Dependencies

  • Requires an API key credential for authenticating with the Voltage API.
  • Needs proper configuration of the Voltage API base URL and timeout settings in the credentials.
  • The organization ID must be valid and accessible with the provided API key.

Troubleshooting

  • Authentication Error (401): Indicates invalid or missing API key. Verify the API key credential configured in n8n.
  • Permission Error (403): The API key lacks permission to start webhooks. Check the API key's access rights.
  • Not Found (404): The specified organization or webhook ID does not exist. Confirm the IDs are correct.
  • Validation Error (422): Input parameters are invalid or incomplete. Ensure all required fields are correctly set.
  • Server Errors (5xx): Temporary issues with the Voltage API. Retry after some time.
  • Failed to parse response as JSON: Usually caused by incorrect credentials or organization ID leading to unexpected API responses.

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

Links and References

Discussion