Extend Connector Capabilities with Custom Fields

Updated on 5th February 2025 by Susanna Fagerholm

In the world of integration, flexibility is key. Organisations need to be able to adapt to the ever-changing data regulations and client needs. Embedded iPaaS (integration Platform as a Service) offer a powerful suite of tools and API connectors that allow users to create seamless integrations between various applications. 

For instance, an embedded integration platform turns an API into a Connector. The Connector is built by an API expert and by default includes widely required methods. It is mapped with the standard fields available by the API. 

However, if there is a type of data required for a specific method but it hasn’t been mapped in the method fields, an embedded iPaaS provides the tools for users to add the necessary methods. These are referred to as Custom Fields. 

What are Custom Fields?

Custom fields in Cyclr, an embedded integration platform allow users to map their own data fields into the request and response fields or Template Connectors. This allows users to tailor their integrations to match the unique data requirements of their business. As a result, it ensures that every piece of information is accurately captured, processed, and transferred between systems. 

It’s important to note that the ability to add custom fields is entirely dependent on the API being worked with. Custom fields can only be added for data fields that have been made available by the API. 

Let’s walk through the process of adding custom fields to Cyclr Connectors.

Understanding the Limitations of Custom Fields

Before diving into the details, it’s important to understand the limitations surrounding custom fields. 

While an embedded iPaaS like Cyclr provides the flexibility for creating integrations, the ability to add Custom Fields is entirely dependent on the third-party API. If the API for the service a user is integrating with does not support the data fields or endpoints required to handle the custom fields, then users will not be able to add them in Cyclr, either. 

Beforehand it is best to check the API’s documentation to ensure that the fields required are available.

Step-by-Step Guide to Adding Custom Fields

Once the fields required are available users can start mapping them in an integration workflow. We will go through the process using Cyclr our embedded integration platform. 

Step 1: A user will need to log in to Cyclr and navigate to Application Connectors. The user will search for the Connector that requires modification. 

The Connector can be found in one of two ways:

• Through the Builder: If a user is in the Builder and working on a template, they can select the Template Connector needed under the Application Connectors. This will expand its options to view the “Settings” option.

• Through the Console: Navigate to Templates and Template Connectors from the main menu. Locate the Connector required and select “Edit Connector”.

Step 2: Navigate to Methods and Fields

In the Connector settings, under Methods and Fields, users can view all the Connectors methods and mapped fields. Users will need to find the required method and open it. This is where users will define the additional fields needed. 

Step 3: Add New Custom Fields

Next users should click “Add Field” to add the new custom field. This new custom field needs to be added to the “Request Fields” or “Response Fields” section. This depends on whether the custom field needed is used to send data (request) or receive data (response).

Users will be prompted to provide the following details:

• Field Name: This is the field name as used by the API. Often this is just a case of copying the syntax of the existing fields.
• Display Name: This is the user-friendly name that will appear in the Cyclr interface. Make sure it’s clear and descriptive.
• Data Type: Choose the appropriate data type for the field (e.g. text, integer, Boolean, dateTime).

Users can write a description of how the field is used or if there are any special considerations for its data.

Finish the setup by clicking “Create”.

Generating Custom Fields with JSON

If users are only adding a few custom fields, they can add them manually following the above process. However, if users need to map multiple custom fields at once, and have a JSON sample of data with the fields needed, users can use the Generate Fields option.

Users will find “Generate Fields” next to “Add Field” in the Connector settings’ Methods and Fields section. Once clicked, it will open a box where users can paste their JSON sample data. Make sure that the sample pasted in only contains properties that are needed as fields.

Once users have put in their JSON sample, click ‘Generate’. Cyclr will add all the new fields that are not yet available in the method, complete with the data type it has detected for each field. This can take a little while, depending on the number of fields generated.

Lastly, check over the field names and data types to ensure they are accurate.

Testing Custom Fields in Connector Settings

Users may notice that when a method is opened in a Connector’s Methods and Fields section, there are two tabs available: Fields and Test.

The Fields tab, as the name suggests, holds all of the method’s data fields. This is where users will add custom fields as we’ve just learned. These newly created fields can be tested directly in the Test tab. 

In the Test tab, users will find a selection of data fields that are available for the method selected. As these methods are not mapped in a cycle or template, users will need to input accurate data to the method’s mandatory fields manually to test them fully. Once “Run” is clicked, Cyclr will run the method using the data provided. 

This offers users a fantastic way to check that custom fields are generated correctly before starting to use them in a customer-facing cycle or template. Giving users an opportunity to tackle any errors, typos or other issues proactively.

It is important to authenticate the Connector before running tests, and these tests do count toward usage. 

Conclusion

Custom fields in Cyclr connectors offer a powerful way to tailor integrations to users’ specific needs. Whether they are doing it manually or using JSON for bulk operations, the process is straightforward when following the steps.

With Cyclr’s customisable connectors, users are not limited by predefined fields, users can create integrations that truly fit business needs. So, get in touch and start exploring the possibilities of custom fields in Cyclr today and take integrations to the next level.

You may also enjoy these…