Open Navigation

Authenticating Connectors

On This Page

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

Some connectors will require authentication against an account in order to use them. If they require authentication, you'll see an 'Add Authentication' button at the top of the properties panel.

There are a number of types of Authentication which may be required:

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
On This Page