Credentials

An integration flow synchronizes data between two or more applications. In order to access these applications credentials are required.

  • Credentials are added to the component for a service or application that you want to integrate with. A component may have multiple sets of credentials for different environments.

  • When building a new flow you are required to select the credentials you want to use. This enables you to trial new flows on a staging environment and then move them to production.

  • Credentials are only available for flows within the workspace in which they are added.

Types of credentials

There a three main types of credentials:

  • API Key: if the integration component is sending requests to a REST API using API key for authorization, then a credential is a simple object holding the API key.

  • OAuth2: In case of a component authorizing through OAuth2, the credential object holds multiple values, such as access_key, refresh_key, scope, etc.

  • Database credentials: If a component goes directly into an application’s database, the credential object holds the database host url, port, database name, username, password.

As you can see in the examples above, a credential is specific to the API it is used to authenticate with. This means a credential for a Salesforce component will not work with a credential for a Database component or any other API.

You can create a credential for a component from the Credentials page, or while you are creating a flow.

Learn how to manage credentials in workspaces to use in flows.

Creating a credential from the Credentials page

Click the Credentials option on the main menu to access the credentials page for the selected workspace. All components that require credentials display. Select the component you want to use and add credentials as per the screenshot below.

Petstore API - Creating a credential for a flow

This example is a REST API component so you need an account name and API key.

  • Account name - an optional name for this credential

  • API key - an API key which will be available from your licenced account with the component software package

When a credential is saved, it will be available for selection when you create a flow in the current workspace, using that component. The same credential can be used multiple times.

The green number on a component icon tells you how many credentials exist for that component, in the selected workspace.

Note that before saving a credential, Connect performs a verification by sending a "dry" request to the particular API. This allows us to avoid saving invalid credentials caused by typos, invalidated API keys, etc.

You can click the Edit or Delete button for an existing credential to it or delete it. If you try to delete a credential being used by an active workflow an error message will display prompting you to delete or update the flow first.

Creating a credential while building a workflow

When building a workflow you will need to select the components that the flow will use. When you select a component you will be prompted to

  • Select credentials that have already been configured

  • Add new credentials

If you add credentials at this stage, you will be prompted to complete the same fields that display on the Credentials page. Again, the credentials are verified before you can continue to avoid errors.