Accounts

Whenever you use external web services (e.g., Gmail, Dropbox, Evernote, etc.) in your workflow, webMethods.io Integration platform accesses those services on your behalf to perform the specified tasks. To do this, you need to grant the necessary permissions and/or basic account details such as client ID, client secret to webMethods.io Integration.

This can be done using accounts.

The accounts are created and used at project level. Meaning, once you create an account for a specific project, you can use it in any workflow created under that project. However, it cannot be used outside that particular project.

It is important to remember that, once you create an account (let’s say for Gmail), you can use the same account for all actions and triggers of Gmail connectors. You need not create a new account for different actions of the same service. Also, there is no limit to the number of authorizations you can create for a service.

Creating accounts

Creating accounts is very easy with webMethods.io Integration. We will understand how to create an account, with the help of an example:

Let's say you want to create an account for Trello. To do this, add the Trello connector on canvas and configure the Create Board action.

1-config-trello.png

Here, you can see the Authorize Trello field. From here, you can create a new account, or access an existing account. 

To create a new account, hover over the + button. You will see two options:

1. Default Authorization

2. (Or)

2-add-auth.png


1. Creating account by generating keys

In the default authorization method, webMethods.io Integration platform generates necessary keys to access your account data. To do so, you need to grant the webMethods.io Integration platform the relevant permissions.

To create an account with default authorization method, click + and then select Default Authorization option.

3-default-auth.png

This will take you to Trello log in page. To authenticate yourself as a user, you need to log in to Trello by entering your credentials. Once this is done, (or if you are already logged in to Trello), the next page will ask you to authorize webMethods.io Integration to perform certain actions on your behalf. Click ALLOW to proceed.

4-trello-allow.png

This will redirect you to the canvas where you will be prompted to provide a suitable name for the account you are about to create. You can optionally use the default name for the account.

5-rename-auth.png

Once this is done, click Add. This will add the specified Trello account for your webMethods.io Integration account.

Now when you click on the Authorize Trello drop down icon, you will see the Trello account you just created in the drop down list.

6-list-auth.png

You can now use this account in any workflow of the project for which you have created this account.

2. Creating account by using existing keys

If you have all the necessary keys and account details required to create an account, you can choose the second method. To do this, Click the + button and select the (Or) option.

7-click-or.png

A pop-up window will appear on screen, where you will be prompted to enter the relevant keys/information required to create the Trello account.

8-add-info.png


Note: Apart from the Account Name field, the rest of the fields that appear in this form will vary depending on the application for which you are creating the account.

Once you have entered the required details, click Save.

This will create the account for the specified connector.

Now when you click on the Authorize Trello drop down icon, you will see the newly created account in the drop down list.

9-list.png

You can now use this account, for any workflow created under the project for which you have created this account.

Creating account for connection-based connectors

There are some connectors, which don't support OAuth, where you can grant webMethods.io Integration the necessary permissions to generate keys on your behalf. For such connectors, you need to provide the necessary details required by the connector API to create an account.

Let's say you want to create an account for Salesforce CRM. 

To do so, add the Salesforce CRM connector on canvas and select any action in the Select Action drop down list.

10-add-conn.png

When you click on the + button given beside the Connect to Salesforce CRM field, a pop-up window will appear on screen.


11-add-conn-acc.png

Note: Apart from the Account Name field, the rest of the fields that appear in this form will vary depending on the application for which you are creating the account.

Provide the necessary details and click Add. This will create the account for the specified connector.

12-list-conn.png


You can now use this account, for any workflow created under the project for which you have created this account.

Managing project-level accounts

You can view, create, modify, and delete the accounts created under a specific project. 

To do this, navigate to the relevant project, click Configurations, and click Accounts.

Viewing accounts

In the Accounts screen under Configurations tab, you can view the list of all accounts created for all connectors under the specified project. It has following details:

Service Name: Connector name for which you have created the account.

Accounts: The name of the account(s). If you have created multiple accounts for a single connector, you can view its list by clicking the drop down icon.

Actions: The name of the action(s) in which the account is being currently used. Clicking on the action name will redirect you to the configuration window of that specific action.

Workflow Name: The name of the workflow(s) in which the account is being currently used. Clicking the workflow name will redirect you to that specific workflow.

13-accounts-screen.png

Creating accounts

You can create additional accounts for a specific connector by clicking on the + icon given against the existing account name. The procedure to create a new account remains same as explained in the previous section.

15-create-acc-config.png

Note: You cannot create accounts for connection-based connectors from the Configurations tab.

Editing and deleting accounts

You can edit or delete the existing accounts. To edit or delete an account, hover over the name of the account.

16-edit-acc.png

You will see two icons Edit and Delete.

Editing accounts

To edit the account, click the Edit icon, and update the relevant details in the Edit Account window  that appears.

17-edited.png

Note: If you have created the account using the Default Authorization method, you can edit only the name of the account. For all other types of accounts, you can edit all details available in the form field.

Once you have made the changes, click Save.

Deleting accounts

To delete the account, click the Delete icon.

18-deleted.png

You will be prompted to confirm the delete action.

19-delete-confirm.png

Click Delete. This will delete the specified account from your project.

If you have used the account in any workflow(s), you will be prompted to remove the account from the workflow(s) first.

7-delete-active-acc.png

Once this is done, go back to Configurations tab, and repeat the procedure explained above.

Managing workflow-specific accounts

All accounts used in a specific workflow can be viewed and deleted via Workflow Settings panel. 

To do so, open the relevant workflow on canvas, click the Workflow Settings icon located at the top-right corner of the canvas, and click Accounts.

20-workflow-setttings.png

From here, you can view and delete the accounts used in the workflow.

Note: Deleting an account from the Workflow Settings panel, will only remove it from the current workflow. It will continue to be available in all other workflows till you delete it permanently from the Configurations tab.

Configuring OAuth V2.0 authentication

While creating an account, the user associates only one connection type or authentication scheme with an Account. As some SaaS providers such as Salesforce CRM offer multiple authentication options to access their APIs, you now select different authentication types for the same Application while creating an Account.

Let’s look at an example to understand how OAuth V2.0 authentication works. Let’s say you want to create an account for Salesforce CRM and use OAuth V2.0 type of authentication.

To configure OAuth V2.0 authentication, add the Salesforce CRM connector on canvas and configure an Account.

Add_Custom_Action.png

If you already have the Operations created from OAuth V2.0 type account, then select one. Else create a new Custom Action. Read more about Custom Actions.

When you click on the + button given beside the Select Action field, the Add Custom Action window appears. Let’s look at the steps involved in setting up OAuth V2.0 authentication.

Step 1: Connect to an account

Here, you see Select Authentication type field. The field lists the connection types based on the supported authentication schemes by the connector.

Click Select Authentication type drop-down list to view the connection types available for the selected application. You will see three options:

  • Credentials
  • OAuth V2.0 (Authorization Code Flow)
  • OAuth V2.0 (JWT Flow)
connect_account.png

Select OAuth V2.0 (Authorization Code Flow)

Next, you see the Authorize Salesforce CRM field. From here, you can create a new account, or access an existing account.

Hover over the + button to create a new account. You will see two options:

1. Default Authorization

2. (Or) Custom auth

connecttoaccount.png

In the default authorization method, webMethods.io Integration platform generates necessary keys to access your account data. To do so, you need to grant the webMethods.io Integration platform the relevant permissions.

To create an account with the default authorization method, click + and then select Default Authorization option.

This will take you to the Salesforce login page. To authenticate yourself as a user, you need to log in to Salesforce by entering your credentials. Once this is done, (or if you are already logged in to Salesforce), the next page will ask you to authorize webMethods.io Integration to perform certain actions on your behalf. Click ALLOW to proceed.

login_salesforce.png

This will redirect you to the canvas where you will be prompted to provide a suitable name for the account you are about to create. You can optionally use the default name for the account.

add_authrorization.png

Once this is done, click Add. This will add the specified Salesforce account for your webMethods.io Integration account.

Now when you click on the Authorize Salesforce CRM drop-down icon, you will see the Salesforce account you just created in the drop-down list.

You can now use this account in any workflow of the project for which you have created this account.