Verify Webhook with Shopify Partner API on New Labeled Email from Gmail API

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

Trigger workflow on

New Labeled Email from the Gmail API

Next, do this

Verify Webhook with the Shopify Partner 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 Gmail trigger and Shopify Partner action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Labeled Email trigger
1. Connect your Gmail account
2. Configure timer
3. Select one or more Labels
Configure the Verify Webhook action
1. Connect your Shopify Partner account
2. Configure App API secret key
3. Configure Shopify HMAC Signature
4. Configure Webhook Body
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 Labeled Email on Gmail

Description:Emit new event when a new email is labeled.

Version:0.0.11

Key:gmail-new-labeled-email

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-history.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "gmail-new-labeled-email",
  name: "New Labeled Email",
  description: "Emit new event when a new email is labeled.",
  type: "source",
  version: "0.0.11",
  dedupe: "unique",
  props: {
    gmail,
    ...common.props,
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
    },
  },
  methods: {
    ...common.methods,
    getHistoryTypes() {
      return [
        "labelAdded",
        "messageAdded",
      ];
    },
    generateMeta(message) {
      return {
        id: `${message.id}-${message.historyId}`,
        summary: `A new message with ID: ${message.id} was labeled"`,
        ts: +message.internalDate,
      };
    },
    filterHistory(history) {
      return history.filter((item) =>
        (item.labelsAdded && item.labelsAdded[0].labelIds.some((i) => this.labels.includes(i)))
        || (item.messagesAdded
          && item.messagesAdded[0].message.labelIds
          && item.messagesAdded[0].message.labelIds.some((i) => this.labels.includes(i))));
    },
  },
  sampleEmit,
};

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
Gmail	`gmail`	`app`	This component uses the Gmail app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Labels	`labels`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

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

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action#

Verify Webhook on Shopify Partner

Description:Verify an incoming webhook from Shopify. Exits the workflow if the signature is not valid, otherwise returns `true`

Version:0.0.5

Key:shopify_partner-verify-webhook

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.

Action Code#

import shopify_partner from "../../shopify_partner.app.mjs";
import crypto from "crypto";

export default {
  name: "Verify Webhook",
  version: "0.0.5",
  key: "shopify_partner-verify-webhook",
  description:
    "Verify an incoming webhook from Shopify. Exits the workflow if the signature is not valid, otherwise returns `true`",
  props: {
    shopify_partner,
    appSecretKey: {
      type: "string",
      secret: true,
      label: "App API secret key",
      description:
        "The secret key associated with the Shopify App receiving the webhook.",
    },
    shopifyHmac: {
      type: "string",
      label: "Shopify HMAC Signature",
      description:
        "The value of the `x-shopify-hmac-sha256` webhook request header. Use `{{steps.trigger.event.headers['x-shopify-hmac-sha256']}}` to reference the header from the HTTP trigger",
    },
    body: {
      type: "any",
      label: "Webhook Body",
      description:
        "The incoming webhook payload. Use `{{ steps.trigger.event.body }}` to reference the request body from the HTTP trigger.",
    },
  },
  type: "action",
  methods: {},
  async run({ $ }) {
    // Webhook documentation on shape, etc.
    // https://shopify.dev/apps/webhooks/configuration/mandatory-webhooks
    const body = this.body;
    const shopifyHmac = this.shopifyHmac;

    // verify webhook origin
    const hash = crypto
      .createHmac("sha256", this.appSecretKey)
      .update(Buffer.from(JSON.stringify(body)))
      .digest("base64");

    if (hash !== shopifyHmac) {
      console.log("Invalid webhook signature, unauthorized");
      console.log(shopifyHmac, hash);
      return $.flow.exit("Invalid webhook signature.");
    }

    return true;
  },
};

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
Shopify Partner	`shopify_partner`	`app`	This component uses the Shopify Partner app.
App API secret key	`appSecretKey`	`string`	The secret key associated with the Shopify App receiving the webhook.
Shopify HMAC Signature	`shopifyHmac`	`string`	The value of the `x-shopify-hmac-sha256` webhook request header. Use `{{steps.trigger.event.headers['x-shopify-hmac-sha256']}}` to reference the header from the HTTP trigger
Webhook Body	`body`	`any`	The incoming webhook payload. Use `{{ steps.trigger.event.body }}` to reference the request body from the HTTP trigger.

Action 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.

More Ways to Connect Shopify Partner + Gmail#

Other Popular Integrations#

Verify Webhook with Shopify Partner API on New Sent Email from Gmail API

Gmail + Shopify Partner