Grant User Access with Uscreen API on New Column from MySQL API

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

Trigger workflow on

New Column from the MySQL 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 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a MySQL 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 Column trigger
1. Connect your MySQL account
2. Configure timer
3. Select a Table
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 Column on MySQL

Description:Emit new event when you add a new column to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/show-columns.html)

Version:2.0.5

Key:mysql-new-column

View on GitHub

MySQL Overview#

The MySQL application on Pipedream enables direct interaction with your MySQL databases, allowing you to perform CRUD operations—create, read, update, delete—on your data with ease. You can leverage these capabilities to automate data synchronization, report generation, and event-based triggers that kick off workflows in other apps. With Pipedream's serverless platform, you can connect MySQL to hundreds of other services without managing infrastructure, crafting complex code, or handling authentication.

Trigger Code#

import common from "../common/table.mjs";

export default {
  ...common,
  key: "mysql-new-column",
  name: "New Column",
  description: "Emit new event when you add a new column to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/show-columns.html)",
  type: "source",
  version: "2.0.5",
  dedupe: "unique",
  props: {
    ...common.props,
    db: "$.service.db",
  },
  methods: {
    ...common.methods,
    _getPreviousColumns() {
      return this.db.get("previousColumns");
    },
    _setPreviousColumns(previousColumns) {
      this.db.set("previousColumns", previousColumns);
    },
    async listResults() {
      const { table } = this;
      let previousColumns = this._getPreviousColumns() || [];
      const columns = await this.mysql.listNewColumns({
        table,
        previousColumns,
      });
      this.iterateAndEmitEvents(columns);

      const newColumnNames =
        columns
          .map((column) => column.Field)
          .filter((c) => !previousColumns.includes(c));

      previousColumns = previousColumns.concat(newColumnNames);
      this._setPreviousColumns(previousColumns);
    },
    generateMeta(column) {
      const columnName = column.Field;
      return {
        id: `${columnName}${this.table}`,
        summary: columnName,
        ts: Date.now(),
      };
    },
  },
};

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
MySQL	`mysql`	`app`	This component uses the MySQL app.
	`timer`	`$.interface.timer`
Table	`table`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs.

SSL Setup

Configure SSL on your MySQL database by providing the CA (Certificate Authority), and choosing between Full Verification, Verify Certificate Authority (CA), or Skip Verification. Skipping verification is not recommended as this has serious security implications.

About MySQL#

MySQL is an open-source relational database management system.

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.