Build Automated IBM Cloud Object Storage-Connected Workflows in Zapier

Zapier is an online automation tool that connects your apps and services. When paired with CData Connect AI, you get access to live IBM Cloud Object Storage data for your workflows. This article shows how to connect to IBM Cloud Object Storage and build workflows with live IBM Cloud Object Storage data in Zapier.

Connect to IBM Cloud Object Storage from Zapier

To work with IBM Cloud Object Storage in Zapier, we need to connect to IBM Cloud Object Storage from Connect AI, provide user access to the connection, and create a Workspace for the IBM Cloud Object Storage data.

Connect to IBM Cloud Object Storage from Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "IBM Cloud Object Storage" from the Add Connection panel

3. Enter the necessary authentication properties to connect to IBM Cloud Object Storage.

   Register a New Instance of Cloud Object Storage

   If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:

   1. Log in to your IBM Cloud account.
   2. Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.

   Connecting using OAuth Authentication

   There are certain connection properties you need to set before you can connect. You can obtain these as follows:

   API Key

   To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:

   1. Log in to your IBM Cloud account.
   2. Navigate to the Platform API Keys page.
   3. On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
   4. In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.

   Cloud Object Storage CRN

   If you have multiple accounts, specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:

   • Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
   • Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.

   Connecting to Data

   You can now set the following to connect to data:

   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • ApiKey: Set this to your API key which was noted during setup.
   • CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.

   When you connect, the connector completes the OAuth process.

   1. Extracts the access token and authenticates requests.
   2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add IBM Cloud Object Storage Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure IBM Cloud Object Storage Endpoints for Zapier

After connecting to IBM Cloud Object Storage, create a workspace for your desired table(s).

1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
2. Click Add to add new assets to the Workspace.
3. Select the IBM Cloud Object Storage connection (e.g. IBMCloudObjectStorage1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to IBM Cloud Object Storage data from Zapier.

Connect to IBM Cloud Object Storage Data in Zapier Workflows

To establish a connection from Zapier to CData Connect AI using the OData protocol, follow these steps.

1. Log into Zapier.
2. Click Create Zap.
3. In the dialog that appears, search for "Webhooks by Zapier", and click the option underneath.
4. Under Event, select Retrieve Poll.
5. Fill in the connection details:
   • URL: Enter the OData URL (e.g. https://cloud.cdata.com/api/odata/{workspace_name}).
   • Key: Enter "value.name."
   • Authentication details: Fill in the Basic Auth or Headers. The basic option requires a user (your Connect AI username, e.g. [email protected]) and password (the PAT you've previously created) separated by a pipe symbol: |. The headers option requires a request type header with encoded credentials.
   
6. Click Test. If the connection is set up properly, sample records will appear.

Simplified Access to IBM Cloud Object Storage Data from Cloud Applications

At this point, you have a direct, cloud-to-cloud connection to live IBM Cloud Object Storage data from Zapier. For more information on gaining simplified access to data from more than 100 SaaS, Big Data, and NoSQL sources in cloud applications like Zapier, refer to our Connect AI page.