FireberryTest icon

FireberryTest

Consume Fireberry API Test

Overview

This node integrates with the Fireberry API to perform various data operations on Fireberry objects. It supports creating, querying, updating, and deleting records individually or in batches. The node is useful for automating workflows that involve managing Fireberry data without manual intervention.

Common scenarios include:

  • Querying Fireberry objects to retrieve specific records based on complex conditions.
  • Creating new records or multiple records at once in Fireberry.
  • Updating existing records individually or in bulk.
  • Deleting records either one by one or in batches.

Practical examples:

  • Automatically syncing customer data from another system into Fireberry by creating or updating records.
  • Running scheduled queries to extract data from Fireberry for reporting or further processing.
  • Cleaning up outdated records by batch deleting them based on certain criteria.

Properties

Name Meaning
Operation The action to perform: Create, Create Batch, Delete, Delete Batch, Query, Update, or Update Batch.
Object Type The Fireberry object type to operate on. Can be selected from a list or specified via expression.
Object Type Selected Hidden boolean indicating if an object type has been selected (true/false).
Fields Names or IDs For query operation: fields to return in the results. Can be selected or specified via expression.
Query Type For query operation: method to create the query - Visual Query Builder or Advanced Query string.
Query For query operation with Advanced Query: the Fireberry query string.
Flattened Query Builder For query operation with Visual Query Builder: a collection of field conditions and logical operators to build the query visually.
Sort By Name or ID Field to sort query results by.
Sort Type Sort order: Ascending or Descending.
Record Limit Maximum number of records to return in query (empty means all).
Show Real Value Whether to show real values instead of only IDs for dropdown and lookup fields in query results.
Fields (Create) For create operation: collection of fields with their names and values to set when creating a record. Supports selecting dropdown values.
Records (Create Batch) For create batch operation: JSON array of records to create, each as an object with field names as keys.
Record ID (Update) For update operation: ID of the record to update.
Fields (Update) For update operation: collection of fields with their names and values to update. Supports selecting dropdown values.
Records (Update Batch) For update batch operation: JSON array of objects each containing an id and a record object with fields to update.
Record ID (Delete) For delete operation: ID of the record to delete.
Record IDs (Delete Batch) For delete batch operation: JSON array of record IDs to delete.

Output

The node outputs an array where each element corresponds to the result of the operation performed on each input item.

  • The main output is JSON data representing the response from the Fireberry API for the requested operation.
  • For query operations, the JSON contains the retrieved records with requested fields.
  • For create, update, and delete operations, the JSON typically contains confirmation or details of the affected records.
  • If an error occurs and "Continue On Fail" is enabled, the output includes an error message per failed item.
  • The node does not explicitly output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Fireberry API.
  • Uses internal methods (getObjects, getObjectFields, getDropdownValues, getFieldTypes) to load options dynamically.
  • No additional external dependencies beyond the Fireberry API and n8n's credential management.

Troubleshooting

  • Unsupported Operation Error: If an unsupported operation is selected, the node throws an error stating the operation is not supported. Ensure you select one of the valid operations.
  • Missing Object Type: Many operations require specifying an object type. Omitting this will cause errors.
  • Invalid Record IDs: For update and delete operations, providing incorrect or non-existent record IDs will cause failures.
  • Query Syntax Errors: When using advanced query strings, syntax errors in the Fireberry query will cause the operation to fail.
  • Dropdown Values Not Loading: If dropdown values do not appear, check that the object type and field selections are correct and that the API credentials have sufficient permissions.
  • Enable "Continue On Fail" to allow the workflow to proceed even if some items fail, capturing error messages in the output.

Links and References

Discussion