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 in scenarios where you need to fetch metadata or configuration information stored as custom fields within an external system, for example, to display or process that data further in your workflow.

Practical examples include:

  • Fetching a custom field's value to use it in conditional logic or decision-making.
  • Retrieving configuration parameters stored as custom fields for dynamic workflow adjustments.
  • Integrating with external systems that store additional user or account attributes as custom fields.

Properties

Name Meaning
Account Id Identifier of the account from which the custom field should be retrieved.
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 relevant properties of the custom field such as its identifier, name, type, value, and any other metadata provided by the external API.

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

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external service's API.
  • The node depends on an external REST API endpoint that provides custom field data.
  • The base URL for the API must be set in the credentials configuration.
  • Uses standard HTTP headers for JSON communication (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Missing or invalid Account Id or Custom Field Id: Ensure both identifiers are correctly provided; otherwise, the API call will fail or return no data.
  • Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions to read custom fields.
  • Network or connectivity issues: Check network access to the external API endpoint.
  • Unexpected API responses: If the API changes or returns errors, verify the API documentation and update the node configuration accordingly.

Common error messages might include:

  • "Unauthorized" or "Authentication failed": Check API credentials.
  • "Not Found" or "Custom field does not exist": Confirm the IDs are correct.
  • "Bad Request": Validate input parameters.

Links and References

  • Refer to the external API documentation for detailed information about custom fields and their retrieval endpoints.
  • n8n documentation on creating and configuring API credentials.
  • General REST API usage guidelines for troubleshooting HTTP errors.

Discussion