Skip to main content

Introduction

The "Integrations" module allows you to easily combine APIs and online services through visual programming. The module provides a user-friendly interface where you can drag and connect node blocks, creating the logic of your applications visually. This simplifies development, making it accessible even for those who are not professional programmers, and significantly speeds up the process of integrating various systems:

Key Elements of the Integrations Module Interface​

Before you start creating your first flows and integrations, let's take a look at the interface. Understanding how the main elements are structured will simplify your work and help you get accustomed more quickly.

1. Left Panel with Nodes​

The left panel is where you will find all available nodes. These are the elements from which you will build your data flows.

To use a node, simply drag it onto the workspace. All nodes have their specific purposes and can be configured individually.

Examples of Nodes:

  • Inject: allows you to manually send data into the flow.
  • Debug: outputs data and messages to the debug menu.
  • Function: allows you to write custom code in JavaScript.
  • Template: used to create text or HTML templates.

2. Tabs​

Tabs are located above the workspace and allow you to switch between different projects or data flows. This is convenient if you are working on multiple integrations simultaneously or want to separate logic into several flows.

  • Creating New Tabs: You can add a new tab by clicking the plus button +. Each new tab represents a separate data flow, helping you better organize your project.
  • Renaming Tabs: To rename a tab, double-click its name and enter a new name. This is especially useful if you have many tabs and want to clearly understand what each one contains.
  • Deleting Tabs: Right-click on a tab and select Delete from the context menu. Be careful not to lose important data.
  • Disabling Tabs: In the same context menu, the Disable option disables the tab's flow without deleting it. For a disabled tab, the option is called Enable — it turns the flow back on. In the JSON schema, this state is stored in the disabled field of the tab.

Example: If you are working on a payment integration, you can create separate tabs for each service.

3. Workspace​

The workspace is the central part of the interface where you build and edit your data flows.

  • Placing Nodes: After you drag a node from the left panel, it will appear in the workspace. Here you can move it, connect it to other nodes, and create the logic of your flow.
  • Connecting Nodes: To connect nodes, simply drag a line from the output of one node to the input of another. This way, data will be passed through the flow from one node to another.
  • Managing Flows: The workspace allows you to create multiple data flows, which helps organize complex integrations and logic.

Tip: You can zoom in and out of the workspace using your mouse or touchpad to see all the details of your flow.

4. Node Editing Form​

When you double-click on a node in the workspace, the node editing form opens. This is the window where you configure the behavior of the node.

  • Settings Fields: Each node has its parameters that you can edit. For example, in the Function node, you can write and edit code.
  • Saving Changes: After editing a node, click the Submit button to save the changes.

Example: In the Function node, you can write JavaScript code that transforms data. In the Template node, you can create a template that dynamically inserts data.

5. Debug Panel​

The debug panel is located on the right and is used to view output data and messages from the Debug node. The panel has two tabs: Debug — stream messages and Configuration.

  • Viewing Messages: When you run the data flow, the Debug node sends messages to the Debug tab. This helps you see what is happening in your flow and check the correctness of the data.
  • Filtering Messages: The list above the messages switches which messages to display: all nodes — from all nodes, current workflow — only from nodes in the current tab. This is convenient when you have a lot of output data from different Debug nodes.
  • Clearing the Debug Window: Click the cross icon next to the filter to remove old messages and focus on new data.

Example: If you are using a Function node to perform calculations, add a Debug node at the end of the flow to check if your code processes the data correctly.

6. Control Buttons​

Full-Screen Button​

  • This button allows you to expand the Integrations module interface to full screen, which is useful when working on complex data flows or when demonstrating the project on a large monitor.
  • By clicking this button, you will have more space for editing and can better see all the details of your flows.

Publish Button​

  • This is the main button that saves and deploys all changes made to your data flows, making them active. After you have added or modified nodes, be sure to click this button for your settings to take effect.

Import Button​

  • This button allows you to import an existing schema from JSON or an example from the list. You can learn more in the Import section.

Input Schema and Passing Schema Between Nodes​

Each node in the editing form displays an Input Schema block — this is the schema of the data coming from the previous node in the flow. The schema shows available fields in the form of "key - type" pairs, taking into account the nesting of objects.

If a field description is available in the API documentation, it will be displayed next to the key. These descriptions are also picked up by the code editor as autocompletions and hints when writing Mustache templates.

Which Nodes Pass the Schema to the Next Node​

Not all nodes can pass the schema. The list of nodes that can do this includes:

  • Function — the schema is formed from the Output Example (JSON) field. This field is also used as test data when calling the flow without actually running the Function code.
  • Admin API — the schema is taken from the method description in the API documentation. When you click the Execute button, the schema is updated with the real API response. Fields that match the API description retain their text descriptions.
  • Http Request — initially, there is no schema. The schema appears after clicking the Execute button and is taken from the real response.

Execute Button​

The Admin API and Http Request nodes support the Execute button in the editing form. It triggers the execution of the entire chain of nodes from the start of the flow to the current node.

Features:

  • The server executes the flow based on the state of the last Publish — before testing, ensure that the flow is published.
  • If the function node in the path does not pass data further but has the Output Example (JSON) filled in, this value is used as test data.
  • Upon a successful response, the result is passed to the next node as a schema.
  • In case of an error, the schema is not passed to the next node.

Automatic Invocation of Read-Only Nodes​

All admin-api nodes that perform read-only requests (GET) are automatically invoked when the Integrations page is opened and when the flow is updated via the Publish button. This ensures that you always have the current data schema without manual triggering.