Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation retrieves the value of a specific custom field associated with an account. It is useful when you need to fetch detailed or user-defined metadata stored as custom fields in an external system, allowing workflows to dynamically access and use these values for further processing or decision-making.

Practical examples include:

  • Fetching a customer's preferred contact method stored as a custom field.
  • Retrieving a product attribute like color or size that is stored as a custom field.
  • Accessing any additional data points configured by users that are not part of standard fields.

Properties

Name Meaning
Account Id Identifier of the account from which the custom field value will be retrieved.
Custom Field Id Identifier of the custom field whose value you want to get.
Custom Field Value Id Identifier of the specific value instance of the custom field to retrieve.

Output

The output contains a JSON object representing the requested custom field value. This typically includes the details of the custom field value such as its identifier, actual value, and possibly metadata related to it.

If the node supports binary data output (not indicated here), it would represent the custom field value in binary form, but based on the provided code and properties, the output is JSON only.

Dependencies

  • Requires an API key credential or similar authentication token to connect to the external service managing accounts and custom fields.
  • The base URL for the API must be configured in the node credentials.
  • The node depends on an OpenAPI specification (payhawk.api.json) for defining operations and request structure.
  • Uses the @devlikeapro/n8n-openapi-node package for handling OpenAPI-based requests.

Troubleshooting

  • Missing or invalid identifiers: Ensure that the Account Id, Custom Field Id, and Custom Field Value Id are correctly specified and exist in the external system.
  • Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions to read custom field values.
  • Network or API errors: Check connectivity and API endpoint availability; ensure the base URL is correctly set.
  • Unexpected response format: If the API changes, the node might fail to parse the response correctly; updating the OpenAPI spec or node version may be necessary.

Links and References

Discussion