Tray Platform / Using Connectors / Connector Builder

Connector Builder

Beta Feature

This feature is currently in beta and so is only available to a limited set of users.

Watch this space as it will be available soon!

main-sc

Overview

The Tray Connector Builder allows you to build your own connectors.

So if you have a service for which there is no pre-built Tray connector, you can create your own connector for the service and then publish it.

Once published, the connector is reviewed and approved by Tray.

If the Connector Builder is not included in your edition of Tray, please use the HTTP Client as an alternative which allows you to make queries to any endpoint within custom services

Building connectors

There are two stages to building a connector.

The first stage involves:

  1. Creating a Custom Service

  2. Creating the connector for the selected service

The second stage involves the following steps and may vary depending on the operations you plan to create for the connector:

  1. Add operations to the connector

  2. Authenticate the connector

  3. Add an HTTP request

  4. Add Operation inputs

  5. Publish the connector

Create a test API service

To follow this tutorial we recommend creating a Back4App application that will serve as a database for our service.

It is a database-like solution that allows you to easily create entities which can then be queried and updated via RESTful API calls.

The following steps will show you how to set up the application:

Important Note

When creating headers for your operation API calls, you should never hardcode any auth credentials, as they will be exposed in your workflow logs.

Instead you should use $.auth jsonpaths to programmatically access the credentials from the authentication:

jsonpath-auth-credentials

Exactly how to do this is explained at the relevant points below.

Example usage

Before you create your connector you need to create a custom service.

The subsequent steps may vary based on the connector operations you wish to create.

We have provided examples for both a GET and POST operation.

For reference, the Back4App documentation explains how to work with their Objects API.

Connecting to a Custom Service

Authenticating with a Custom Service

When you create a connector for any custom service, you need to authenticate the service, as explained in the Authenticate the connector section of the Get Details of Customer example.

Get Details of Customer (GET)

Once you have created your connector, you can add various operations to it.

The first operation we are adding for the Customer connector is Get Details of Customer. This operation will fetch details of a specific customer based on the provided unique ID.

Add a New Customer (POST)

We learned how to add an operation with the GET request method in the above section. In this section will see how you can add a new operation with the POST request method.

This operation we are adding is Add a New Customer. It will add a new customer to the Customer database.

Publish the connector

Once you have created your connector, added and tested all the operations. The last step is to Publish the connector.

publish

While building, the connector is in a Draft state. Once published, it will be in the Review state. The connector will be reviewed by our members in Tray. Once reviewed, you will receive an email notifying you about its status.

If everything seems right with the connector in terms of functionality, security, etc. Your connector will be Published.