Add Student to Course with Xperiencify API on New SMS Received (Instant) from Plivo API

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

Trigger workflow on

New SMS Received (Instant) from the Plivo API

Next, do this

Add Student to Course with the Xperiencify 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 Plivo trigger and Xperiencify action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New SMS Received (Instant) trigger
1. Connect your Plivo account
2. Select a Phone Number
Configure the Add Student to Course action
1. Connect your Xperiencify account
2. Select a Course
3. Configure Student
4. Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Password
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 SMS Received (Instant) on Plivo

Description:Emit new event when a new SMS is received. [See the docs](https://www.plivo.com/docs/sms/api/message#send-a-message).

Version:0.0.1

Key:plivo-new-sms-received

View on GitHub

Plivo Overview#

The Plivo API taps into the power of cloud communication, allowing you to programmatically send SMS messages, make voice calls, and manage user verifications among other telephony functions. With Pipedream's serverless platform, you can easily integrate Plivo into workflows that automate these communication tasks, react to incoming messages or calls, and connect with numerous other apps for comprehensive automation solutions.

Trigger Code#

import common from "../common/webhook.mjs";
import constants from "../../common/constants.mjs";
import { v4 as uuid } from "uuid";

export default {
  ...common,
  key: "plivo-new-sms-received",
  name: "New SMS Received (Instant)",
  description: "Emit new event when a new SMS is received. [See the docs](https://www.plivo.com/docs/sms/api/message#send-a-message).",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  props: {
    ...common.props,
    phoneNumber: {
      propDefinition: [
        common.props.app,
        "phoneNumber",
      ],
    },
  },
  methods: {
    ...common.methods,
    listMessages(args = []) {
      return this.app.makeRequest({
        path: "messages.list",
        args,
      });
    },
    getResourcesFn() {
      return this.listMessages;
    },
    getResourcesFnArgs() {
      const messageTime = this.getLastMessageTime();
      return messageTime
        ? {
          limit: constants.DEFAULT_LIMIT,
          message_time__gt: messageTime,
        }
        : {
          limit: constants.DEFAULT_LIMIT,
        };
    },
    getPhoneNumber() {
      return this.phoneNumber;
    },
    generateMeta(resource) {
      if (resource.messageUuid) {
        return {
          id: resource.messageUuid,
          ts: Date.parse(resource.messageTime),
          summary: `History SMS received from ${resource.fromNumber}`,
        };
      }
      return {
        id: resource.MessageUUID,
        ts: Date.now(),
        summary: `New SMS received from ${resource.From}`,
      };
    },
    isResourceRelevant(resource) {
      return resource.messageDirection === constants.RESOURCE.MSG.DIRECTION.INBOUND
        && resource.messageState === constants.RESOURCE.MSG.STATUS.DELIVERED
        && resource.messageType === constants.RESOURCE.MSG.TYPE.SMS;
    },
    getApplicationName() {
      return `PipedreamInboundSMS${uuid()}`;
    },
  },
};

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
Plivo	`app`	`app`	This component uses the Plivo 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.
Phone Number	`phoneNumber`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

All requests to Plivo API are authenticated with BasicAuth using your AUTH ID and AUTH TOKEN. Your Plivo AUTH ID and AUTH TOKEN can be found when you login to your dashboard.

About Plivo#

SMS API and Voice API platform

Action#

Add Student to Course on Xperiencify

Description:Adds a student to a course. [See docs](https://howto.xperiencify.com/article.php?article=123#1)

Version:0.0.1

Key:xperiencify-add-student-to-course

View on GitHub

Xperiencify Overview#

Xperiencify is a platform designed to create engaging online courses that motivate students through gamification and psychological triggers. The Xperiencify API allows course creators to manage and automate tasks related to courses, students, and their progress. With Pipedream, you can harness this API to create dynamic workflows that respond to course enrollments, progress milestones, and other student interactions. Automate notifications, gather analytics, synchronize with other platforms, and more, creating a seamless integration between Xperiencify and your digital ecosystem.

Action Code#

import { defineAction } from "@pipedream/types";
import xperiencify from "../../app/xperiencify.app.mjs";
export default defineAction({
    name: "Add Student to Course",
    description: "Adds a student to a course. [See docs](https://howto.xperiencify.com/article.php?article=123#1)",
    key: "xperiencify-add-student-to-course",
    version: "0.0.1",
    type: "action",
    props: {
        xperiencify,
        courseId: {
            propDefinition: [
                xperiencify,
                "courseId",
            ],
        },
        student: {
            // user will input a new email
            type: xperiencify.propDefinitions.student.type,
            label: xperiencify.propDefinitions.student.label,
            description: xperiencify.propDefinitions.student.description,
        },
        firstName: {
            type: "string",
            label: "First Name",
        },
        lastName: {
            type: "string",
            label: "Last Name",
            optional: true,
        },
        password: {
            type: "string",
            label: "Password",
            description: "If left blank, a password will be generated",
            secret: true,
            optional: true,
        },
    },
    async run({ $ }) {
        const response = await this.xperiencify.addStudentToCourse({
            $,
            data: {
                course_id: this.courseId,
                student_email: this.student,
                first_name: this.firstName,
                last_name: this.lastName,
                password: this.password,
            },
        });
        $.export("$summary", `Successfully added student ${this.student} to course`);
        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
Xperiencify	`xperiencify`	`app`	This component uses the Xperiencify app.
Course	`courseId`	`integer`	Select a value from the drop down menu.
Student	`student`	`string`	The student's email address
First Name	`firstName`	`string`
Last Name	`lastName`	`string`
Password	`password`	`string`	If left blank, a password will be generated

Action Authentication#

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

To retrieve your API key: