Verify Webhook with Shopify Partner API on New Transaction Created from Ramp API

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

Trigger workflow on

New Transaction Created from the Ramp 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 Ramp 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 Transaction Created trigger
1. Connect your Ramp account
2. Configure timer
3. Optional- Select a Department ID
4. Optional- Select a Location ID
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 Transaction Created on Ramp

Description:Emit new event for each new transaction created in Ramp.

Version:0.0.2

Key:ramp-new-transaction-created

View on GitHub

Ramp Overview#

The Ramp API provides programmatic access to financial and accounting functionalities, allowing for the management of company cards, transactions, and reporting. By leveraging the Ramp API within Pipedream, you can automate intricate finance operations, synchronize transaction data with accounting software, trigger notifications based on spending activities, and analyze financial data in real-time, integrating with other services for enhanced financial workflows.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "ramp-new-transaction-created",
  name: "New Transaction Created",
  description: "Emit new event for each new transaction created in Ramp.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    departmentId: {
      propDefinition: [
        common.props.ramp,
        "departmentId",
      ],
    },
    locationId: {
      propDefinition: [
        common.props.ramp,
        "locationId",
      ],
    },
  },
  methods: {
    ...common.methods,
    _getLatestTransactionId() {
      return this.db.get("latestTransactionId");
    },
    _setLatestTransactionId(id) {
      this.db.set("latestTransactionId", id);
    },
    getResourceFn() {
      return this.ramp.listTransactions;
    },
    getParams() {
      const latestTransactionId = this._getLatestTransactionId();
      const params = {
        order_by_date_asc: true,
        department_id: this.departmentId,
        location_id: this.locationId,
      };
      if (latestTransactionId) {
        params.start = latestTransactionId;
      }
      return params;
    },
    generateMeta(transaction) {
      return {
        id: transaction.id,
        summary: `New Transaction ID: ${transaction.id}`,
        ts: Date.parse(transaction.user_transaction_time),
      };
    },
    emitResults(results, max) {
      if (max && results.length > max) {
        results = results.slice(-1 * max);
      }
      this._setLatestTransactionId(results[results.length - 1].id);
      results.reverse().forEach((transaction) => {
        const meta = this.generateMeta(transaction);
        this.$emit(transaction, meta);
      });
    },
  },
  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
Ramp	`ramp`	`app`	This component uses the Ramp app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Department ID	`departmentId`	`string`	Select a value from the drop down menu.
Location ID	`locationId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

transactions:readcards:readcards:writespend_programs:readspend_programs:writeusers:readusers:writelocations:readlocations:writelimits:readlimits:writedepartments:readdepartments:writebusiness:readreceipts:readtransfers:readvendors:readmerchants:readaccounting:readreceipts:write

About Ramp#

The Corporate Card That Helps You Spend Less

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.