Open Navigation

Authenticating Connectors

Connectors Introduction

Connectors are the building blocks of your Tray workflows. In this section you will find guidance on how to use both the functional 'Helper/Core' connectors (Text Helper, Data Storage Helper etc.) and the third-party 'Service' Connectors.

Authenticating Service Connectors

When using a service connector, the first thing you will need to do is go to your Tray.io account page, and either select the appropriate workflow or create a new one with your preferred trigger selected. Once you have done this, you will be redirected to the Tray.io workflow dashboard itself.

It is at this stage that you would select the connector of your choice. You achieve this by heading over to the Connectors panel on the left hand side of the dashboard.

Search for your connector of choice by name (it doesn't have to be complete or even the first word) and then click and drag the connector from the panel to the next step of your workflow.


As you can see in the gif, the Slack connector step has a red notification icon above it. This is to indicate that the connector has not had its authentication set up.

authentication-connector-slack-auth-red-icon

With the new connector step highlighted, in the properties panel on the right, you should now see various options available to you. Under the Setting heading, you will see a an Authentication field. Click on the 'New Authentication' button.

authentication-connector-slack-auth-button

A pop-up window should automatically appear once you have pressed this button, similar to the below.

Name your authentication as desired, and be sure to scroll through the parameters to make sure your settings are correct for your project requirements.

Sometimes it may appear that there are only a couple of parameters needed, when in actual fact if you scroll through you will find more at the bottom so its always good practice to check the scroll feature in the auth window!

You may also get a secondary window to confirm your access settings, but this is NOT mandatory and depends entirely on the connector itself if you will need the second stage as demonstrated above.


Please take note that every connector authentication window is unique!. There are many variables involved that are dependant on the service's own requirements and API calls. So if your authentication window does not look exactly like the above, then don't worry.

Please see individual service connector documentation for more specific detailing on how to set up your individual connectors authentication process.

API token-based authentication

If you are using a service such as Stripe and the API uses simple token-based authorisation then a box to enter the API token will be displayed:

auth-enter-api-key

OAuth-based authentication

APIs that use OAuth display a more complex box. From here you can reduce the scope permissions. Be careful: reducing the scope permissions might prevent the connector from functioning properly (required scopes are described in individual connector docs).

Clicking NEXT will open a separate window for you to log in to that service. Once you have logged in you will be returned to the Workflow Editor and your OAuth token will be stored.


Generic Authentications

For some connectors a more general mechanism is available for authentication. For example, the HTTP Client connector does not make any assumptions about how authorisation will work as it is designed as a general purpose API interface.

When you add an authentication with the HTTP Client you can choose a name for your auth token and then enter the actual token value. This auth token can then be used in your API call (for example, as a parameter) by including the path $.auth.token_name.

Please see the HTTP Client guide for an illustration of how this generic apporach works.

Certificate-based Authentication

Tray can also support certificate-based authentications. Please contact us if you need a custom certificate-based authentication built for your service.

Modifying Authentications

The authentications which have been set up for your account can be viewed under the Authentications tab on the dashboard.

my-auths-list

To modify an authorisation select EDIT from the menu to the right of the authentication you want to modify. You can also use DELETE in this menu to remove an authentication. Once removed, you will have to create a new authentication through the editor in order to connect to that API again.

Was this article helpful?
Yes
No