Build Automated JSON-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 JSON services for your workflows. This article shows how to connect to JSON and build workflows with live JSON services in Zapier.

Connect to JSON from Zapier

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

Connect to JSON 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 "JSON" from the Add Connection panel

3. Enter the necessary authentication properties to connect to JSON.

   See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models JSON APIs as bidirectional database tables and JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

   After setting the URI and providing any authentication values, set DataModel to more closely match the data representation to the structure of your data.

   The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

   • Document (default): Model a top-level, document view of your JSON data. The data provider returns nested elements as aggregates of data.
   • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
   • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

   See the Modeling JSON Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add JSON 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 JSON Endpoints for Zapier

After connecting to JSON, 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 JSON connection (e.g. JSON1) 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 JSON services from Zapier.

Connect to JSON Services 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 JSON Services from Cloud Applications

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