VOOZH about

URL: https://www.cdata.com/kb/tech/cosmosdb-cloud-zapier.rst

⇱ Build Automated Cosmos DB-Connected Workflows in Zapier

Build Automated Cosmos DB-Connected Workflows in Zapier

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Connect AI to connect to live Cosmos DB data and build automated 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 Cosmos DB data for your workflows. This article shows how to connect to Cosmos DB and build workflows with live Cosmos DB data in Zapier.

Connect to Cosmos DB from Zapier

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

Connect to Cosmos DB 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. 👁 Adding a Connection
  2. Select "Cosmos DB" from the Add Connection panel
    3. 👁 Selecting a data source
  3. Enter the necessary authentication properties to connect to Cosmos DB.

    To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

    • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
    • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.
    👁 Configuring a connection (Salesforce is shown)
  4. Click Save & Test
  5. Navigate to the Permissions tab in the Add Cosmos DB Connection page and update the User-based permissions. 👁 Updating 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. 👁 Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure Cosmos DB Endpoints for Zapier

After connecting to Cosmos DB, 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). 👁 The Workspaces page.
    👁 Adding a new Workspace.
  2. Click Add to add new assets to the Workspace.
  3. Select the Cosmos DB connection (e.g. CosmosDB1) and click Next. 👁 Selecting an Asset (Salesforce is shown).
  4. Select the table(s) you wish to work with and click Confirm. 👁 Selecting Tables (Salesforce is shown).
  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 Cosmos DB data from Zapier.

Connect to Cosmos DB 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. 👁 Creating a Webhooks by Zapier Zap.
  4. Under Event, select Retrieve Poll. 👁 Creating a Retrieve Poll event.
  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.
    👁 Configuring the connection to Connect AI OData or Workspace URLs.
  6. Click Test. If the connection is set up properly, sample records will appear. 👁 Testing the connection.

Simplified Access to Cosmos DB Data from Cloud Applications

At this point, you have a direct, cloud-to-cloud connection to live Cosmos DB 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.