Voltage icon

Voltage

Interact with Voltage API
Join our community

Actions18

Overview

This node interacts with the Voltage API to manage webhooks within an organization. Specifically, the Webhook - Get All operation retrieves a list of all webhooks associated with a given organization. This is useful for scenarios where you want to monitor, audit, or manage webhook configurations programmatically.

Practical examples include:

  • Fetching all configured webhooks to display them in a dashboard.
  • Automating synchronization of webhook settings across environments.
  • Auditing webhook usage and status for compliance or debugging.

Properties

Name Meaning
Organization ID The unique identifier of the organization whose webhooks you want to retrieve.
Filters Optional filters to limit or paginate results:
- Limit Maximum number of webhook records to return (default 50).
- Offset Number of webhook records to skip before starting to collect the result set (default 0).

Output

The output is an array of JSON objects, each representing a webhook. Each webhook object contains details such as its URL, description, subscribed event types, status, and other metadata as returned by the Voltage API.

The node does not output binary data for this operation.

Example output structure (simplified):

[
  {
    "id": "webhook-id-123",
    "url": "https://example.com/webhook",
    "description": "My webhook",
    "event_types": ["send.created", "receive.paid"],
    "status": "active",
    "created_at": "2023-01-01T12:00:00Z",
    ...
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with the Voltage API.
  • The node uses the official Voltage API SDK client internally.
  • Requires proper configuration of the API base URL and timeout via 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 your API credentials.
  • Permission Error (403): Your API key lacks permission to access the organization's webhooks. Check API key scopes.
  • Not Found (404): The specified organization ID does not exist or is inaccessible.
  • Validation Error (422): Input parameters are invalid; check that the organization ID and filters are correctly formatted.
  • Server Errors (5xx): Temporary issues with the Voltage API service; 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