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 - Get operation retrieves detailed information about a specific webhook by its ID. This is useful for scenarios where you need to verify webhook configurations, inspect their status, or fetch metadata related to a particular webhook.

Practical examples:

  • Fetching details of a webhook to confirm its subscribed event types and URL.
  • Retrieving webhook information before updating or deleting it.
  • Auditing webhook configurations in an automated workflow.

Properties

Name Meaning
Organization ID The unique identifier of the organization owning the webhook.
Webhook ID The unique identifier of the webhook to retrieve.

Output

The node outputs a JSON object representing the webhook's details as returned by the Voltage API. This typically includes fields such as the webhook's URL, description, subscribed event types, status, creation date, and other metadata.

The output structure is:

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

(Note: The exact fields depend on the Voltage API response.)

No binary data 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.

Troubleshooting

  • Common issues:

    • Invalid or missing API key credential will cause authentication errors.
    • Incorrect organization ID or webhook ID will result in "Not Found" errors.
    • Network or server issues may cause timeouts or server errors.

  • Error messages and resolutions:

    • Authentication Error (401): Invalid API key or credentials.
      Check that your API key credential is correct and has necessary permissions.
    • Not Found (404): Organization, environment, or resource not found.
      Verify that the organization ID and webhook ID are valid and exist.
    • Validation Error (422): The request data is invalid. Please check your parameters.
      Ensure all required parameters are provided and correctly formatted.
    • Server Error (5xx): The Voltage API is experiencing issues.
      Retry after some time or contact Voltage support if persistent.

Links and References

Discussion