Create Tag with Google Tag Manager API on New Order Event (Instant) from WooCommerce API

Pipedream makes it easy to connect APIs for Google Tag Manager, WooCommerce and 2,000+ other apps remarkably fast.

Trigger workflow on

New Order Event (Instant) from the WooCommerce API

Next, do this

Create Tag with the Google Tag Manager API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Order Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create Tag action
1. Connect your Google Tag Manager account
2. Select a Account ID
3. Select a Container ID
4. Select a Workspace ID
5. Configure Name
6. Configure Type
7. Optional- Configure Live Only
8. Optional- Configure Notes
9. Configure Parameter
10. Optional- Configure Consent Settings
11. Optional- Configure Monitoring Metadata
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 Order Event (Instant) on WooCommerce

Description:Emit new event each time the specified order event(s) occur

Version:0.0.4

Key:woocommerce-new-order-event

View on GitHub

WooCommerce Overview#

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. With the WooCommerce API, you can tap into the heart of your eCommerce store to read, create, update, and delete products, orders, and customers. On Pipedream, you can harness this API to automate routine tasks, sync data across platforms, and enhance customer experiences. By connecting WooCommerce to a wide array of apps and services, you can streamline operations, trigger personalized marketing, and analyze your sales data with greater ease.

Trigger Code#

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

export default {
  ...common,
  key: "woocommerce-new-order-event",
  name: "New Order Event (Instant)",
  description: "Emit new event each time the specified order event(s) occur",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listOrders({
        per_page: perPage,
        orderby: "date",
      });
    },
    getTopic(topicType) {
      return `order.${topicType}`;
    },
    generateMeta(eventType, {
      id, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Order ID: ${id} ${eventType}`,
        ts,
      };
    },
  },
  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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Event topics	`topics`	`string[]`	Select a value from the drop down menu:`createdupdateddeleted`

Trigger Authentication#

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

Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

Action#

Create Tag on Google Tag Manager

Description:Create a tag in a workspace. [See the documentation](https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/workspaces/tags/create)

Version:0.0.2

Key:google_tag_manager-create-tag

View on GitHub

Google Tag Manager Overview#

The Google Tag Manager API allows you to manage your tags, triggers, variables, and related configurations programmatically. Through Pipedream, you can integrate these API capabilities into serverless workflows to automate complex tagging tasks, sync configurations across environments, and streamline marketing or analytics operations. Pipedream's platform facilitates the creation of custom automations with Google Tag Manager, helping you deploy tags faster, manage user permissions, and control versions of your tag configurations.

Action Code#

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

export default {
  name: "Create Tag",
  version: "0.0.2",
  key: "google_tag_manager-create-tag",
  description: "Create a tag in a workspace. [See the documentation](https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/workspaces/tags/create)",
  type: "action",
  props: {
    app,
    accountId: {
      optional: false,
      propDefinition: [
        app,
        "accountId",
      ],
    },
    containerId: {
      optional: false,
      propDefinition: [
        app,
        "containerId",
        (c) => ({
          accountId: c.accountId,
        }),
      ],
    },
    workspaceId: {
      optional: false,
      propDefinition: [
        app,
        "workspaceId",
        (c) => ({
          accountId: c.accountId,
          containerId: c.containerId,
        }),
      ],
    },
    name: {
      propDefinition: [
        app,
        "name",
      ],
    },
    type: {
      propDefinition: [
        app,
        "type",
      ],
    },
    liveOnly: {
      propDefinition: [
        app,
        "liveOnly",
      ],
    },
    notes: {
      propDefinition: [
        app,
        "notes",
      ],
    },
    parameter: {
      propDefinition: [
        app,
        "parameter",
      ],
    },
    consentSettings: {
      propDefinition: [
        app,
        "consentSettings",
      ],
    },
    monitoringMetadata: {
      propDefinition: [
        app,
        "monitoringMetadata",
      ],
    },
  },
  async run({ $ }) {
    const parameter = typeof this.parameter === "string"
      ? JSON.parse(this.parameter)
      : this.parameter;
    const consentSettings = typeof this.consentSettings === "string"
      ? JSON.parse(this.consentSettings)
      : this.consentSettings;
    const monitoringMetadata = typeof this.monitoringMetadata === "string"
      ? JSON.parse(this.monitoringMetadata)
      : this.monitoringMetadata;

    const response = await this.app.createTag({
      $,
      accountId: this.accountId,
      containerId: this.containerId,
      workspaceId: this.workspaceId,
      data: {
        name: this.name,
        type: this.type,
        liveOnly: this.liveOnly,
        notes: this.notes,
        parameter,
        consentSettings,
        monitoringMetadata,
      },
    });

    if (response) {
      $.export("$summary", `Successfully created tag with ID ${response.tagId}`);
    }

    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
Google Tag Manager	`app`	`app`	This component uses the Google Tag Manager app.
Account ID	`accountId`	`string`	Select a value from the drop down menu.
Container ID	`containerId`	`string`	Select a value from the drop down menu.
Workspace ID	`workspaceId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the tag
Type	`type`	`string`	The type of the tag. Learn more about available types in Tag Dictionary Reference
Live Only	`liveOnly`	`boolean`	Whether the tag should only fire in the live environment
Notes	`notes`	`string`	Any notes or comments about the tag
Parameter	`parameter`	`string`	The list of parameters for the tag. Learn more about available parameters in Tag Dictionary Reference
Consent Settings	`consentSettings`	`string`	The consent settings for the tag. Learn more in Tag Manager API Documentation and Consent Settings Documentation
Monitoring Metadata	`monitoringMetadata`	`string`	The monitoring metadata for the tag. Learn more in Tag Manager API Doc

Action Authentication#

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

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

emailprofilehttps://www.googleapis.com/auth/tagmanager.readonlyhttps://www.googleapis.com/auth/tagmanager.edit.containershttps://www.googleapis.com/auth/tagmanager.publish