Create Endpoint with QStash API on Student Added to Course from Xperiencify API

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

Trigger workflow on

Student Added to Course from the Xperiencify API

Next, do this

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

Select this integration
Configure the Student Added to Course trigger
1. Connect your Xperiencify account
2. Configure timer
3. Select a Course
Configure the Create Endpoint action
1. Connect your QStash account
2. Select a QStash Topic
3. Configure Endpoint URL
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#

Student Added to Course on Xperiencify

Description:Emit new event when a student enrolls into a course.

Version:0.0.2

Key:xperiencify-student-added-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.

Trigger Code#

import { defineSource } from "@pipedream/types";
import xperiencify from "../../app/xperiencify.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
export default defineSource({
    name: "Student Added to Course",
    description: "Emit new event when a student enrolls into a course.",
    key: "xperiencify-student-added-to-course",
    version: "0.0.2",
    type: "source",
    dedupe: "unique",
    props: {
        xperiencify,
        db: "$.service.db",
        timer: {
            type: "$.interface.timer",
            default: {
                intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
            },
        },
        courseId: {
            propDefinition: [
                xperiencify,
                "courseId",
            ],
        },
    },
    methods: {
        getMeta({ email, firstName, }) {
            return {
                id: email,
                summary: `New student ${firstName}: ${email}`,
                ts: new Date().getTime(),
            };
        },
    },
    async run() {
        const all = await this.xperiencify.getStudentsForCourse({
            courseId: this.courseId,
        });
        for (const student of all) {
            this.$emit(student, this.getMeta(student));
        }
    },
});

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
Xperiencify	`xperiencify`	`app`	This component uses the Xperiencify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Course	`courseId`	`integer`	Select a value from the drop down menu.

Trigger 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:

Navigate to your Xperiencify account and sign in
Go to Account > Advanced > API

About Xperiencify#

Xperiencify is the world's first fully gamified online course platform that creates a hyper-engaging "experience" for your students.

Action#

Create Endpoint on QStash

Description:Create a new HTTP endpoint on a QStash topic.

Version:0.0.1

Key:qstash-create-endpoint

View on GitHub

QStash Overview#

QStash API offers a secure, scalable, and simple way to manage message queues and defer tasks. Using this API, you can enqueue messages, schedule tasks to run after a delay, and ensure that tasks are executed exactly once, leveraging the power of serverless architecture. With Pipedream's ability to connect to a multitude of services, you can build complex workflows that trigger actions in other apps based on events in QStash, allowing you to automate cross-application business processes with ease.

Action Code#

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

export default {
  name: "Create Endpoint",
  version: "0.0.1",
  key: "qstash-create-endpoint",
  description: "Create a new HTTP endpoint on a QStash topic.",
  props: {
    qstash,
    topicId: {
      type: "string",
      label: "QStash Topic",
      description: "The QStash topic to subscribe to.",
      async options() {
        const topics = await this.qstash.listTopics({
          $: this,
        });

        return topics.map((topic) => ({
          label: topic.name,
          value: topic.topicId,
        }));
      },
    },
    endpointUrl: {
      propDefinition: [
        qstash,
        "endpointUrl",
      ],
    },
  },
  type: "action",
  methods: {},
  async run({ $ }) {
    const {
      topicId, topicName, endpointUrl,
    } = this;
    return this.qstash.createEndpoint({
      $,
      topicId,
      topicName,
      endpointUrl,
    });
  },
};

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
QStash	`qstash`	`app`	This component uses the QStash app.
QStash Topic	`topicId`	`string`	Select a value from the drop down menu.
Endpoint URL	`endpointUrl`	`string`	User controlled service url where we will send webhooks to.

Action Authentication#

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