Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation allows users to create a new custom field within an account in an external system. Custom fields are user-defined data points that can be attached to records or entities, enabling more flexible and tailored data management. This operation is useful when you want to extend the default data schema with additional attributes specific to your business needs.

Practical examples include:

  • Adding a "Customer Loyalty Level" field to customer profiles.
  • Creating a "Project Deadline" date field for project management records.
  • Defining a "Preferred Contact Method" dropdown list for contacts.

Properties

Name Meaning
Account Id Identifier of the account where the custom field will be created.
Label The display label/name of the custom field.
Is Required Boolean indicating if this custom field must always have a value (true/false).
Description A textual description explaining the purpose or usage of the custom field.
External Id Unique identifier of the custom field in the external system (optional).
External Source Unique identifier of the external system where the custom field is defined (optional).
Type The type of the custom field. Options: Dynamic List, Predefined List, Free Text Input, Date.

Output

The node outputs JSON data representing the newly created custom field as returned by the external API. This typically includes all properties of the custom field such as its ID, label, type, whether it is required, description, and any external identifiers.

If the node supports binary data output, it would relate to attachments or files associated with the custom field, but based on the provided code and properties, this node focuses solely on JSON data.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to connect to the external system's API.
  • The base URL for the API must be set in the credentials configuration.
  • The node depends on an OpenAPI-based client library to interact with the external API.

Troubleshooting

  • Missing Required Fields: If "Account Id" or "Label" is not provided, the API will likely reject the request. Ensure these mandatory fields are filled.
  • Invalid Field Type: Selecting a type outside the allowed options may cause errors. Use one of the predefined types: dynamic_list, predefined_list, free_text_input, or date.
  • Authentication Errors: If the API key or credentials are incorrect or missing, the node will fail to authenticate. Verify credentials in n8n settings.
  • API Endpoint Issues: Network problems or incorrect base URL configuration can cause connection failures. Confirm the API endpoint is reachable and correctly set.
  • Duplicate External Ids: Using an externalId already existing in the external system might cause conflicts. Use unique identifiers.

Links and References

Discussion