Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Webhook Subscriptions → Get Webhook Subscription

AI-generated

Overview

This node operation retrieves details of a specific webhook subscription from an external service. It is useful when you need to fetch the current configuration or status of a particular webhook subscription associated with an account. For example, you might use this to verify that a webhook subscription exists, check its properties before updating it, or audit active subscriptions.

Properties

Name Meaning
Account Id Identifier of the account to which the webhook subscription belongs.
Subscription Id Identifier of the specific webhook subscription to retrieve.

Output

The output will contain a JSON object representing the webhook subscription details fetched from the external API. This typically includes information such as subscription metadata, event types subscribed to, endpoint URLs, status, and other relevant configuration data.

If the node supports binary data output (not indicated here), it would represent any binary payloads related to the subscription, but in this case, the output is purely JSON.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to authorize requests to the external service.
  • The node uses a base URL defined in the credentials for making API calls.
  • No additional external dependencies are indicated beyond standard HTTP request capabilities.

Troubleshooting

  • Missing or invalid Account Id or Subscription Id: Ensure both identifiers are provided and correct; otherwise, the API call will fail.
  • Authentication errors: Verify that the API key or authentication token is correctly set up in n8n credentials.
  • Network or connectivity issues: Check network access to the external service's API endpoint.
  • API response errors: If the subscription does not exist or has been deleted, the API may return a 404 error. Confirm the subscription ID is valid.
  • Unexpected response format: If the external API changes, the node’s parsing logic might fail; review API documentation for updates.

Links and References

  • Refer to the external service’s official API documentation for detailed information on webhook subscription objects and retrieval endpoints.
  • n8n documentation on configuring API credentials and using HTTP request nodes may be helpful for setup.

Discussion