Create an Invite with Envoy API on New App Charges from Shopify Partner API

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

Trigger workflow on

New App Charges from the Shopify Partner API

Next, do this

Create an Invite with the Envoy 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 Envoy 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 Charges trigger
1. Connect your Shopify Partner account
2. Configure timer
3. Optional- Configure createdAtMin
4. Optional- Configure createdAtMin
Configure the Create an Invite action
1. Connect your Envoy account
2. Configure Arrival date
3. Select a Location
4. Configure Name
5. Optional- Configure Email
6. Optional- Select a Host
7. Optional- Configure Departure date
8. Optional- Configure Private notes
9. Optional- Configure Send email to invitee
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 Charges on Shopify Partner

Description:Emit new events when new app charges made to your partner account.

Version:0.0.18

Key:shopify_partner-new-app-charges

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 getAppTransactions from "../../common/queries/getAppTransactions.mjs";

export default {
  key: "shopify_partner-new-app-charges",
  name: "New App Charges",
  type: "source",
  version: "0.0.18",
  description:
    "Emit new events when new app charges made to your partner account.",
  ...common,
  props: {
    ...common.props,
    createdAtMin: {
      type: "string",
      description:
        "Only include transactions after this specific time (ISO timestamp)",
      label: "createdAtMin",
      optional: true,
    },
    createdAtMax: {
      type: "string",
      description:
        "Only include transactions up to this specific time (ISO timestamp)",
      label: "createdAtMin",
      optional: true,
    },
  },
  async run() {
    const {
      createdAtMin, createdAtMax, db,
    } = this;

    const variables = {};
    if (createdAtMin) {
      variables.createdAtMin = createdAtMin.trim();
    }
    if (createdAtMax) {
      variables.createdAtMax = createdAtMax.trim();
    }

    await this.shopify.query({
      db,
      key: "shopify_partner-transactions",
      query: getAppTransactions,
      variables,
      hasNextPagePath: "transactions.pageInfo.hasNextPage",
      getCursor: () => {
        return null;
      },
      handleEmit: (data) => {
        console.log(
          data.transactions.edges.map(({ node: { ...txn } }) => txn.id),
        );

        data.transactions.edges.map(({ node: { ...txn } }) => {
          this.$emit(txn, {
            id: txn.id,
            summary: `Transaction ${txn.id} earned ${txn.netAmount.amount} ${txn.netAmount.currencyCode}`,
          });
        });
      },
    });
  },
};

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
createdAtMin	`createdAtMin`	`string`	Only include transactions after this specific time (ISO timestamp)
createdAtMin	`createdAtMax`	`string`	Only include transactions up to this specific time (ISO timestamp)

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#

Create an Invite on Envoy

Description:Create an Invite to a person to visit a location. [See the docs](https://developers.envoy.com/hub/reference/createinvite).

Version:0.0.1

Key:envoy-create-an-invite

View on GitHub

Envoy Overview#

The Envoy API empowers users to streamline workplace operations, particularly visitor management, deliveries, and room bookings. Leveraging Pipedream's capabilities, you can automate tasks involving these aspects. For example, you can receive notifications when guests arrive, sync visitor data with other systems, or automate the creation and management of room bookings.

Action Code#

import app from "../../envoy.app.mjs";

export default {
  key: "envoy-create-an-invite",
  name: "Create an Invite",
  description: "Create an Invite to a person to visit a location. [See the docs](https://developers.envoy.com/hub/reference/createinvite).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    expectedArrivalAt: {
      propDefinition: [
        app,
        "expectedArrivalAt",
      ],
    },
    locationId: {
      propDefinition: [
        app,
        "locationId",
      ],
    },
    name: {
      propDefinition: [
        app,
        "visitorName",
      ],
    },
    email: {
      propDefinition: [
        app,
        "visitorEmail",
      ],
    },
    hostEmployeeId: {
      propDefinition: [
        app,
        "employeeId",
      ],
      description: "Unique identifier of a host.",
    },
    expectedDepartureAt: {
      propDefinition: [
        app,
        "expectedDepartureAt",
      ],
    },
    notes: {
      propDefinition: [
        app,
        "notes",
      ],
    },
    sendEmailToInvitee: {
      propDefinition: [
        app,
        "sendEmailToInvitee",
      ],
    },
  },
  async run({ $ }) {
    const data = {
      invite: {
        expectedArrivalAt: this.expectedArrivalAt,
        expectedDepartureAt: this.expectedDepartureAt,
        locationId: this.locationId,
        notes: this.notes,
        sendEmailToInvitee: this.sendEmailToInvitee,
        hostEmployeeId: this.hostEmployeeId,
        invitee: {
          name: this.name,
          email: this.email,
        },
      },
    };
    const response = await this.app.createInvite($, data);
    $.export("$summary", `Successfully created an invite with id: "${response.data.id}"`);
    return response;
  },
};

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
Envoy	`app`	`app`	This component uses the Envoy app.
Arrival date	`expectedArrivalAt`	`string`	A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Location	`locationId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Visitor full name.
Email	`email`	`string`	Visitor email address.
Host	`hostEmployeeId`	`string`	Select a value from the drop down menu.
Departure date	`expectedDepartureAt`	`string`	A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Private notes	`notes`	`string`	Enter your private notes.
Send email to invitee	`sendEmailToInvitee`	`boolean`	Either it should or not send email to invitee

Action Authentication#

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

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

locations.readcompanies.reademployees.readtoken.refreshinvites.readentries.readinvites.write