Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node allows you to retrieve details of a specific custom field associated with an account. It is useful when you need to fetch metadata or configuration stored in custom fields for accounts, such as user-defined attributes or settings that are not part of the standard data model.

Practical examples include:

  • Fetching a custom field value to use it in subsequent workflow steps.
  • Validating or displaying custom field information before performing updates or other operations.
  • Integrating with external systems that require access to custom field data.

Properties

Name Meaning
Account Id Identifier of the account whose custom field you want to retrieve.
Custom Field Id Identifier of the specific custom field to get details for.

Output

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

If the node supports binary data output (not evident from the provided code), it would be summarized here, but based on the static analysis, the output is JSON only.

Dependencies

  • Requires an API key credential for authentication to the external service (referred generically).
  • The node uses a base URL configured in credentials to make HTTP requests.
  • Depends on an OpenAPI specification (payhawk.api.json) for defining available operations and properties.

Troubleshooting

  • Missing or invalid Account Id or Custom Field Id: Ensure these required inputs are correctly set; otherwise, the API call will fail.
  • Authentication errors: Verify that the API key or authentication token is valid and properly configured in the node credentials.
  • Network or API endpoint issues: Check connectivity and that the base URL is correct.
  • Unexpected response structure: If the API changes, the node might not parse the response correctly; updating the OpenAPI spec or node version may be necessary.

Links and References

  • Refer to the external API documentation for details on custom fields and their schema.
  • n8n documentation on creating and using custom nodes with OpenAPI specifications.

Discussion