Verify Webhook with Shopify Partner API on New Followed Streams from Twitch API

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

Trigger workflow on

New Followed Streams from the Twitch 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 Twitch 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 Followed Streams trigger
1. Connect your Twitch account
2. Configure timer
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 Followed Streams on Twitch

Description:Emit new event when a followed stream is live.

Version:0.1.2

Key:twitch-followed-streams

View on GitHub

Twitch Overview#

The Twitch API unlocks a world of possibilities for engaging with live streaming communities and understanding audience behaviors. With Pipedream, you can harness this API to automate many aspects of Twitch interaction and analysis. From tracking stream stats to automating chat messages, the Twitch API lets you create workflows that interact with Twitch's vast live streaming ecosystem. Pipedream's serverless platform streamlines these tasks, making it simple to connect Twitch with other services for enhanced functionalities.

Trigger Code#

import common from "../common-polling.mjs";

export default {
  ...common,
  name: "New Followed Streams",
  key: "twitch-followed-streams",
  description: "Emit new event when a followed stream is live.",
  version: "0.1.2",
  type: "source",
  methods: {
    ...common.methods,
    getMeta(item) {
      const {
        id, started_at: startedAt,
        title: summary,
      } = item;
      const ts = new Date(startedAt).getTime();
      return {
        id,
        summary,
        ts,
      };
    },
  },
  hooks: {
    async deploy() {
      // get the authenticated user
      const { data: authenticatedUserData } = await this.twitch.getUsers();
      this.db.set("authenticatedUserId", authenticatedUserData[0].id);
    },
  },
  async run() {
    const params = {
      from_id: this.db.get("authenticatedUserId"),
    };
    // get the user_ids of the streamers followed by the authenticated user
    const follows = await this.paginate(
      this.twitch.getUserFollows.bind(this),
      params,
    );
    const followedIds = [];
    for await (const follow of follows) {
      followedIds.push(follow.to_id);
    }
    // get and emit streams for the followed streamers
    const streams = await this.paginate(this.twitch.getStreams.bind(this), {
      user_id: followedIds,
    });
    for await (const stream of streams) {
      this.$emit(stream, this.getMeta(stream));
    }
  },
};

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
Twitch	`twitch`	`app`	This component uses the Twitch app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

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

analytics:read:extensionsanalytics:read:gamesbits:readchannel:read:subscriptionsclips:edituser:edituser:edit:broadcastuser:read:broadcastuser:read:emailuser:read:followsuser:read:blocked_usersuser:manage:blocked_usersmoderator:read:followerschannel:read:editorschannel:manage:videosuser:read:subscriptions

About Twitch#

Twitch is an interactive livestreaming service for content spanning gaming, entertainment, sports, music, and more.

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

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.6",
  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);
      if ($.flow) {
        return $.flow.exit("Invalid webhook signature.");
      } else {
        throw new Error("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