Grant User Access with Uscreen API on New Coupon Event (Instant) from WooCommerce API

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

Trigger workflow on

New Coupon Event (Instant) from the WooCommerce API

Next, do this

Grant User Access with the Uscreen 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 Uscreen action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Coupon Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Grant User Access action
1. Connect your Uscreen account
2. Configure Email
3. Select a Product ID
4. Select a Product type
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 Coupon Event (Instant) on WooCommerce

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

Version:0.0.3

Key:woocommerce-new-coupon-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";

export default {
  ...common,
  key: "woocommerce-new-coupon-event",
  name: "New Coupon Event (Instant)",
  description: "Emit new event each time the specified coupon event(s) occur",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listCoupons({
        per_page: perPage,
        orderby: "date",
      });
    },
    getTopic(topicType) {
      return `coupon.${topicType}`;
    },
    generateMeta(eventType, {
      id, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Coupon ID: ${id} ${eventType}`,
        ts,
      };
    },
  },
};

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#

Grant User Access on Uscreen

Description:Grant access to an user. [See the documentation](https://uscreen.io/api/publisher.html#/default/post_customers__customer_id__accesses)

Version:0.0.1

Key:uscreen-grant-user-access

View on GitHub

Uscreen Overview#

The Uscreen API lets you programmatically access your video on demand and OTT (over-the-top) service. With this API, you can pull data about videos, users, and sales, and carry out actions like creating and updating users, and more. By leveraging the Uscreen API on Pipedream, you can automate workflows involving video content management, user engagement tracking, and sales monitoring. This can significantly cut down manual effort and streamlines operations within your Uscreen account.

Action Code#

import app from "../../uscreen.app.mjs";
import constants from "../common/constants.mjs";

export default {
  name: "Grant User Access",
  version: "0.0.1",
  key: "uscreen-grant-user-access",
  description: "Grant access to an user. [See the documentation](https://uscreen.io/api/publisher.html#/default/post_customers__customer_id__accesses)",
  type: "action",
  props: {
    app,
    email: {
      type: "string",
      label: "Email",
      description: "The email to grant access",
    },
    productId: {
      propDefinition: [
        app,
        "offerId",
      ],
    },
    productType: {
      type: "string",
      label: "Product type",
      description: "The type of the product",
      reloadProps: true,
      options: constants.PRODUCT_TYPES,
    },
  },
  async additionalProps() {
    let props = {};

    if (this.productType === "offer") {
      props.withManualBilling = {
        type: "boolean",
        label: "Manual billing",
        description: "Is with manual billing",
      };
    }

    return props;
  },
  async run({ $ }) {
    const response = await this.app.grantUserAccess({
      $,
      email: this.email,
      data: {
        product_id: this.productId,
        product_type: this.productType,
        with_manual_billing: this.withManualBilling,
      },
    });

    if (response) {
      $.export("$summary", `Successfully created user with ID \`${response.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
Uscreen	`app`	`app`	This component uses the Uscreen app.
Email	`email`	`string`	The email to grant access
Product ID	`productId`	`string`	Select a value from the drop down menu.
Product type	`productType`	`string`	Select a value from the drop down menu:`{ "label": "Offer", "value": "offer" }{ "label": "Program", "value": "program" }`

Action Authentication#

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

The UScreen API is available to Uscreen Plus customers but if you're not on the Plus plan, you can contact the UScreen team to inquire about access. Your CSM can provide you with your authorization key to use in the API. See the documentation here.