List Contacts with TidyCal API on New App Relationship Events from Shopify Partner API

Pipedream makes it easy to connect APIs for TidyCal, Shopify Partner and 2,400+ other apps remarkably fast.

Trigger workflow on

New App Relationship Events from the Shopify Partner API

Next, do this

List Contacts with the TidyCal API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Shopify Partner trigger and TidyCal action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New App Relationship Events trigger
1. Connect your Shopify Partner account
2. Configure timer
3. Configure Shopify App ID
4. Optional- Configure occurredAtMin
5. Optional- Configure occurredAtMax
6. Optional- Configure Maximum records to query per run
7. Select a Pagination direction
Configure the List Contacts action
1. Connect your TidyCal account
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New App Relationship Events on Shopify Partner

Description:Emit new events when new shops installs, uninstalls, subscribes or unsubscribes your app.

Version:0.1.3

Key:shopify_partner-new-app-relationship-events

View on GitHub

Shopify Partner Overview#

The Shopify Partner API lets you tap into a comprehensive suite of features to manage and analyze multiple Shopify stores. You can automate tasks like creating development stores, adding collaborators, tracking payouts, and more. This API serves as a powerful tool for developers, agencies, and freelancers who manage multiple Shopify shops for their clients. Through Pipedream, you can effortlessly integrate Shopify Partner API with other services to create tailored, efficient workflows that save time and enhance productivity.

Trigger Code#

import common from "../../common/common.mjs";
import shopify from "../../shopify_partner.app.mjs";
import getAppRelationshipEventsBackwards from "../../common/queries/getAppRelationshipEventsBackwards.mjs";
import getAppRelationshipEventsForwards from "../../common/queries/getAppRelationshipEventsForwards.mjs";

export default {
  key: "shopify_partner-new-app-relationship-events",
  name: "New App Relationship Events",
  type: "source",
  version: "0.1.3",
  description:
    "Emit new events when new shops installs, uninstalls, subscribes or unsubscribes your app.",
  ...common,
  props: {
    ...common.props,
    db: "$.service.db",
    appId: {
      propDefinition: [
        shopify,
        "appId",
      ],
    },
    occurredAtMin: {
      propDefinition: [
        shopify,
        "occurredAtMin",
      ],
    },
    occurredAtMax: {
      propDefinition: [
        shopify,
        "occurredAtMax",
      ],
    },
    recordsPerRun: {
      propDefinition: [
        shopify,
        "recordsPerRun",
      ],
    },
    paginationDirection: {
      propDefinition: [
        shopify,
        "paginationDirection",
      ],
    },
  },
  async run() {
    const {
      appId,
      occurredAtMin,
      occurredAtMax,
      db,
      paginationDirection,
      recordsPerRun,
    } = this;

    const variables = {
      appId: `gid://partners/App/${appId}`,
    };
    if (occurredAtMin) {
      variables.occurredAtMin = occurredAtMin.trim();
    }
    if (occurredAtMax) {
      variables.occurredAtMax = occurredAtMax.trim();
    }

    console.log("Querying events");

    await this.shopify.query({
      db,
      key: "shopify_partner-relationship-events",
      query:
        this.paginationDirection === "backward" ||
        !this.db.get("shopify_partner-relationship-events") // on the first run, pull records from present day
          ? getAppRelationshipEventsBackwards
          : getAppRelationshipEventsForwards,
      variables,
      handleEmit: (data) => {
        data.app.events.edges.map(({ node: { ...event } }) => {
          this.$emit(event, {
            id: event.occurredAt,
            summary: `${event.shop.name} (${event.shop.myshopifyDomain}) installed ${event.app.name}`,
          });
        });
      },
      getCursor: (data) => {
        const edges = data?.app?.events?.edges || [];
        if (this.paginationDirection === "backward") {
          const last = edges[edges.length - 1];
          console.log("Last event in batch: ", last);
          return last?.cursor;
        } else {
          const [
            first,
          ] = edges;
          console.log("First event in batch: ", first);
          return first?.cursor;
        }
      },
      hasNextPagePath:
        this.paginationDirection === "forward" ||
        !this.db.get("shopify_partner-relationship-events")
          ? "app.events.pageInfo.hasNextPage"
          : "app.events.pageInfo.hasPreviousPage",
      paginationDirection,
      recordsPerRun,
    });
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Shopify Partner	`shopify`	`app`	This component uses the Shopify Partner app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
timer	`timer`	`$.interface.timer`	API Polling Frequency
Shopify App ID	`appId`	`string`	Open your app in the partner portal, and look at the URL to find its ID. If your URL is https://partners.shopify.com/3027494/apps/51358007297/overview, enter `51358007297` here.
occurredAtMin	`occurredAtMin`	`string`	Only include events after this specific time (ISO timestamp)
occurredAtMax	`occurredAtMax`	`string`	Only include events up to this specific time (ISO timestamp)
Maximum records to query per run	`recordsPerRun`	`integer`	Number of records to retrieve per run
Pagination direction	`paginationDirection`	`string`	Select a value from the drop down menu:`{ "label": "Forwards", "value": "forward" }{ "label": "Backwards", "value": "backward" }`

Trigger Authentication#

Shopify Partner uses API keys for authentication. When you connect your Shopify Partner account, Pipedream securely stores the keys so you can easily authenticate to Shopify Partner APIs in both code and no-code steps.

Create an API Key

In order to authorize Pipedream to access your Shopify Partner Account, you will need to generate a new API key for Pipedream to use on your behalf.

First, create an API client in your Shopify Partner account.

Make sure to include these scopes:

View financials
Manage apps

You will use this API key to authenticate your Pipedream workflows with Shopify Partners.

Open API key management in the Shopify Partner Portal

Create a new API key

Create API key

Enter in "Pipedream" as the name and select the appropriate scopes, then click "Save" to finish

Enter in Pipedream API key options

Find your Organization ID

After you log into the Shopify Partner portal, look at the URL for your organization ID

Find your Shopify Partner Organization ID

Find your App ID

After opening your app in the partner portal, look in the URL to find it's ID:

Find your Shopify App ID

About Shopify Partner#

Shopify Partner API connection. Listen to events like installs, uninstalls, charges & transactions.

Action#

List Contacts on TidyCal

Description:Get a list of contacts. [See the documentation](https://tidycal.com/developer/docs/#tag/Contacts/operation/list-contacts)

Version:0.0.1

Key:tidycal-list-contacts

View on GitHub

TidyCal Overview#

The TidyCal API allows for scheduling automation, linking your calendar to create and manage bookings. In Pipedream, you can harness this API to create event-driven workflows, such as syncing with other calendar services, triggering reminders, or connecting with CRM systems to streamline your scheduling process. Pipedream's serverless platform enables you to build and run these workflows efficiently, without the need to manage infrastructure.

Action Code#

import app from "../../tidycal.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "tidycal-list-contacts",
  name: "List Contacts",
  description: "Get a list of contacts. [See the documentation](https://tidycal.com/developer/docs/#tag/Contacts/operation/list-contacts)",
  type: "action",
  version: "0.0.1",
  props: {
    app,
  },
  async run({ $: step }) {
    const response = this.app.getResourcesStream({
      resourceFn: this.app.listContacts,
      resourceName: "data",
    });

    const resources = await utils.streamIterator(response);

    step.export("$summary", `Successfully retrieved ${utils.summaryEnd(resources.length, "contact")}.`);

    return resources;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
TidyCal	`app`	`app`	This component uses the TidyCal app.

Action Authentication#

TidyCal uses OAuth authentication. When you connect your TidyCal account, Pipedream will open a popup window where you can sign into TidyCal and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any TidyCal API.

Pipedream requests the following authorization scopes when you connect your account: