Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation allows users to create a new custom field value within an account. It is useful in scenarios where you want to extend the data model by adding additional metadata or attributes that are not part of the standard fields. For example, if you manage customer accounts and want to add a custom tag or category to each account, this operation lets you define those custom values programmatically.

Practical examples include:

  • Adding a custom label to categorize accounts by region or priority.
  • Creating external identifiers for integration with other systems.
  • Defining custom attributes that can be used later for filtering or reporting.

Properties

Name Meaning
Account Id Identifier of the account to which the custom field value will be added.
Custom Field Id Identifier of the specific custom field for which the value is being created.
Label The display label or name of the custom field value.
External Id A unique identifier for the custom field value in an external system (optional).

Output

The output JSON contains the details of the newly created custom field value. This typically includes the assigned ID, label, external ID (if provided), and any metadata returned by the API confirming the creation.

If the node supports binary data output, it would represent associated files or attachments related to the custom field value, but based on the provided code and properties, this operation focuses on JSON data only.

Dependencies

  • Requires an API key credential to authenticate requests against the external service managing custom fields.
  • The base URL for the API must be configured in the node credentials.
  • The node depends on an OpenAPI-based client library for request construction and response parsing.

Troubleshooting

  • Missing Required Fields: Ensure that Account Id, Custom Field Id, and Label are provided; otherwise, the API will reject the request.
  • Authentication Errors: Verify that the API key or authentication token is correctly set up in the node credentials.
  • Invalid Identifiers: Double-check that the Account Id and Custom Field Id correspond to existing entities in the external system.
  • Network Issues: Confirm network connectivity and that the base URL is reachable.
  • API Limitations: If the API enforces rate limits or quotas, handle errors accordingly and consider retry mechanisms.

Links and References

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

Discussion