Grant User Access with Uscreen API on New Incoming SMS (Instant) from Twilio API

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

Trigger workflow on

New Incoming SMS (Instant) from the Twilio 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 Twilio 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 Incoming SMS (Instant) trigger
1. Connect your Twilio account
2. Select a Incoming Phone Number
3. Optional- Configure Response Message
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 Incoming SMS (Instant) on Twilio

Description:Emit new event every time an SMS is sent to the phone number set. Configures a webhook in Twilio, tied to an incoming phone number.

Version:0.1.4

Key:twilio-new-incoming-sms

View on GitHub

Twilio Overview#

Twilio's API on Pipedream opens up a multitude of communication capabilities, allowing you to build robust, scalable, and automated workflows. With Twilio, you can send and receive SMS and MMS messages, make voice calls, and perform other communication functions programmatically. Leveraging Pipedream's seamless integration, you can connect these communications features with hundreds of other services to automate notifications, streamline customer interactions, and enhance operational efficiency.

Trigger Code#

import twilio from "twilio";
import common from "../common/common-webhook.mjs";
import constants from "../../common/constants.mjs";

const MessagingResponse = twilio.twiml.MessagingResponse;

export default {
  ...common,
  key: "twilio-new-incoming-sms",
  name: "New Incoming SMS (Instant)",
  description: "Emit new event every time an SMS is sent to the phone number set. Configures a webhook in Twilio, tied to an incoming phone number.",
  version: "0.1.4",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    responseMessage: {
      propDefinition: [
        common.props.twilio,
        "responseMessage",
      ],
    },
  },
  methods: {
    ...common.methods,
    getServiceType() {
      return constants.SERVICE_TYPE.SMS;
    },
    getResponseBody() {
      const twiml = new MessagingResponse();
      let responseBody = "<Response></Response>";
      if (this.responseMessage) {
        twiml.message(this.responseMessage);
        responseBody = twiml.toString();
      }
      return responseBody;
    },
    generateMeta(body, headers) {
      return {
        /** if Twilio retries a message, but we've already emitted, dedupe */
        id: headers["i-twilio-idempotency-token"],
        summary: body.Body,
        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
Twilio	`twilio`	`app`	This component uses the Twilio app.
Incoming Phone Number	`incomingPhoneNumber`	`string`	Select a value from the drop down menu.
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.
Response Message	`responseMessage`	`string`	The message you want to send in response to incoming messages. Leave this blank if you don't need to issue a response.

Trigger Authentication#

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

To connect your Twilio account to Pipedream,

API Key and API Key SID

First, create an API key in Twilio.

There are three types of keys: Main, Standard, and Restricted. You'll need a Main key to interact with certain API endpoints, like /Accounts.
If you don't need to interact with those endpoints, you can use a Standard or Restricted key.

After creating your key, you'll see fields for Sid and Secret. Enter those in the fields below.

Account SID and Auth Token

Visit your Twilio Dashboard. You'll see your Account SID and Auth Token under Account info.

About Twilio#

Twilio is a cloud communications platform for building SMS, Voice & Messaging applications on an API built for global scale.

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.

About Uscreen#

Uscreen is an all-in-one membership platform designed for video creators.⚡ Follow us for the best free video streaming tips!

More Ways to Connect Uscreen + Twilio#

Other Popular Integrations#

Create User with Uscreen API on New Call (Instant) from Twilio API

Twilio + Uscreen