Connection Builder Connection Builder

Connection Builder

Eric Soelzer Eric Soelzer

Where data comes in and data goes out

Connection builder is designed to be your gateway to the outside world, and the place where you can perform more complex data interactions. You can interact with our first class data integrations, connect to any RESTful endpoint, and much much more. The focus of this document is to give you an outline of the key areas of the connection builder to help get you started. connectionBuilder1.png

Tree

The tree is left side of the window, next to the builder selector. It contains several different sections which will talk about below.

connectionBuilder2.png

Data Operations

Where all your custom connections are located.

App API

This section allows you to define "routes" that can be targeted from external sources. This can be used for session to session, App to App, or External Source to App.

Subscriptions

Subscribe to updates to your tickets, leads and more. Subscriptions work with our first class integrations so your customer journeys can begin and be updated from the systems already used by your team.

Stage

connectionBuilder3.png

In the stage you will see the individual connection steps. Each step has inputs and outputs. In each step you will fill out the specific details needed for that particular connection. The format of each step will change depending on the step type. We’ve broken down different connection types below.

Connection Types

Transform

Allows you to transform or shape data from one format to another. This can be useful if you have multiple data objects that you ask the user to fill out where you have to merge the objects for your api request. Alternatively, you might have a request to a system that returns more information than needed in the Airkit experience. Either way, this connection step allows you to modify the data and interact with Airscript to get the data in the right format.

HTTP

Connect to external RESTful APIs to pull data in or export data out of your Airkit experience. You have full control over the request that’s being made, and we have the ability to work with many different authentication methods.

All the fields allow for Airscript to be inputted, that way you can interact with any variables that are available inside your connection.

Object-Service

Don’t already have a system of record? Feel free to use us! The object-service connection allows you to not only query, but also save and delete data that you store within Airkit. This connection allows you to store your data inside of the Airkit platform, which is then visible by going to the Data Builder.

Other Connection Types

There are other connection types not listed here. If you have any questions about the additional types please reach out to the CXE or CSM team at Airkit for more information.

Inspector

connectionBuilder4.png

The inspector shows you the variables that you have available to you. When you invoke a connection, you pass the connection data that results in its starting parameters. Every frame inside your connection can generate a variable. Any variable created is available to all the frames after the one in which it was created.

 

Was this article helpful?

0 out of 0 found this helpful

Add comment

Article is closed for comments.