Actions18
- Payment Actions
- Wallet Actions
- Line of Credit Actions
- Webhook Actions
Overview
This node integrates with the Voltage API to manage webhooks within an organization. Specifically, the Webhook - Create operation allows users to create a new webhook that listens for specified event types and sends those events to a designated URL.
Common scenarios where this node is beneficial include:
- Automating workflows triggered by payment or wallet events in Voltage.
- Integrating Voltage event notifications into external systems via webhooks.
- Setting up custom alerting or logging based on specific Voltage events.
For example, you can create a webhook that listens for "Send - Succeeded" and "Receive - Paid" events and forwards these to your internal monitoring system's URL, enabling real-time updates on payment statuses.
Properties
| Name | Meaning |
|---|---|
| Organization ID | The unique identifier of the organization under which the webhook will be created. |
| Webhook URL | The destination URL where Voltage will send webhook event payloads. |
| Webhook Description | Optional text describing the webhook's purpose or details. |
| Event Types | 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 newly created webhook object as returned by the Voltage API. This typically includes details such as the webhook ID, URL, subscribed event types, description, 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 Voltage API SDK client configured with the provided API key, base URL, and timeout settings.
- Proper permissions on the API key are necessary to create webhooks within the specified organization.
Troubleshooting
- Validation Error (422): Indicates invalid request data. Check that all required fields (Organization ID, Webhook URL) are correctly set and that event types are valid.
- Authentication Error (401): Occurs if the API key is invalid or missing. Verify the API key credential configuration.
- Permission Error (403): The API key lacks permission to create webhooks. Ensure the key has appropriate access rights.
- Not Found (404): The specified organization ID does not exist or is incorrect.
- Server Errors (5xx): Temporary issues with the Voltage API service; retry after some time.
- Non-JSON Response: Usually indicates authentication or organization ID issues; verify credentials and parameters.
If the node is set to continue on failure, errors are returned in the output JSON with detailed error information.
Links and References
- Voltage API Documentation (general reference for API endpoints and webhook management)
- Voltage API SDK (for understanding client methods used)
This summary is based solely on static analysis of the provided source code and property definitions.