Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node is designed to retrieve a specific custom field from an account in an external system. It is useful when you need to fetch detailed information about a particular custom field associated with an account, for example, to display its properties or use its data in subsequent workflow steps.

Practical examples include:

  • Fetching metadata of a custom field to validate or process it.
  • Retrieving a custom field's value to use in conditional logic or data transformation.
  • Integrating with external systems where custom fields define additional attributes for accounts.

Properties

Name Meaning
Account Id Identifier of the account from which to get the custom field.
Custom Field Id Identifier of the specific custom field to retrieve.

Output

The node outputs JSON data representing the details of the requested custom field. This typically includes all properties and metadata associated with that custom field as returned by the external API.

If the node supports binary data output (not evident from the provided code), it would represent any file or media content related to the custom field, but this is not indicated here.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external service.
  • The node uses an OpenAPI-based client internally to communicate with the external API.
  • The base URL for the API must be set in the credentials configuration.

Troubleshooting

  • Missing or invalid Account Id or Custom Field Id: Ensure these required parameters are correctly set; otherwise, the API call will fail.
  • Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions.
  • Network or connectivity issues: Check network access to the external API endpoint.
  • Unexpected API responses: Confirm that the custom field exists and is accessible under the specified account.

Common error messages might include "Not Found" if the custom field or account does not exist, or "Unauthorized" if authentication fails.

Links and References

  • Refer to the external API documentation for details on custom fields and their structure.
  • Consult n8n documentation on how to configure API credentials and use OpenAPI-based nodes.

Discussion