Fireberry icon

Fireberry

Consume Fireberry API

Overview

The node "Fireberry" integrates with the Fireberry API to manage data objects and their fields. Specifically, the "Create Field" operation allows users to add a new custom field to an existing object type within Fireberry. This is useful for extending the schema of your data objects dynamically without manual intervention in the Fireberry UI or backend.

Common scenarios include:

  • Adding specialized fields to track additional information on records, such as custom text, dates, or numeric values.
  • Creating relationship fields (lookup) to link objects.
  • Defining calculated fields using formulas or summaries to automate data aggregation.
  • Setting up dropdown (picklist) fields with predefined options for consistent data entry.

Practical example:
You have a "Customer" object and want to add a new "Loyalty Points" numeric field to track customer rewards. Using this node, you specify the object, field type as "Number", set the field name and label, and define precision. The field is then created programmatically in Fireberry.

Properties

Name Meaning
Object Type Name or ID The target object type in Fireberry where the new field will be created. Choose from a list or specify an ID via expression.
Field Type The type of field to create. Options include: Date, Date & Time, Email, Formula, HTML, Lookup, Number, Phone, Picklist, Summary, Text, Text Area, URL.
Field Name (API) The unique API name for the field. Must start with "pcf" and be unique within the object.
Label The display name for the field as it appears in the Fireberry UI.
Default Value Optional default value for new records. Applicable for text, textarea, email, url, phone, number, date, datetime field types.
Track Changes Boolean flag indicating whether changes to this field should be tracked in system logs. Available for most field types except formula and summary.
Auto Complete Boolean flag to enable auto-complete suggestions based on previously used values. Available for text, email, url, phone, and number fields.
Max Length Maximum allowed characters for text, email, and url fields (1-200).
Precision Number of decimal places for number fields (0 to 4).
Related Object Name or ID For lookup and summary fields, specifies the related object to which this field connects. Choose from list or specify ID via expression.
Picklist Values JSON array defining options for picklist (dropdown) fields. Each option has a "name" and "value".
Summary Type For summary fields, defines the calculation type: Average, Count, Maximum, Minimum, Sum.
Summary Related Object Name or ID For summary fields, the related object whose records are summarized. Choose from list or specify ID via expression.
Summary Field For summary types sum, avg, min, max, specifies the field to summarize.
Formula For formula fields, the expression that calculates the field's value. Required for formula type.
Formula Field Type Data type returned by the formula: Text, Number, Date, Boolean.
Formula Precision Number of decimal places for numeric formula results (0 to 4). Only applicable if formulaFieldType is Number.

Output

The node outputs a JSON object representing the result of the field creation operation. This typically includes details about the newly created field such as its ID, name, type, and other metadata returned by the Fireberry API.

No binary data output is involved in this operation.

Dependencies

  • Requires a valid API key credential for Fireberry API authentication configured in n8n.
  • Depends on Fireberry API availability and permissions to modify object schemas.
  • Uses internal methods to load available objects and fields dynamically for user selection.

Troubleshooting

  • Error: "The operation 'createField' is not supported!"
    Occurs if the operation parameter is incorrect or missing. Ensure the operation is set exactly to "createField".

  • Validation errors on Field Name
    The API name must start with "pcf" and be unique. If violated, the API may reject the request.

  • Invalid JSON in Picklist Values
    The picklistValues property expects a valid JSON array. Malformed JSON will cause errors.

  • Missing required parameters
    Required fields like objectType, fieldType, fieldName, and label must be provided. Missing these will cause failures.

  • API permission issues
    Insufficient permissions to create fields in Fireberry will result in authorization errors.

To resolve errors, verify all required inputs, ensure correct formatting, and confirm API credentials and permissions.

Links and References

Discussion