Send Message (Advanced) with Discord API on Student Added to Course from Xperiencify API

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

Trigger workflow on

Student Added to Course from the Xperiencify API

Next, do this

Send Message (Advanced) with the Discord API

No credit card required

▶

Watch us build a workflow

4 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 Xperiencify trigger and Discord 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 Send Message (Advanced) action
1. Connect your Discord account
2. Configure channel
3. Optional- Configure Message
4. Optional- Configure Thread ID
5. Optional- Configure Username
6. Optional- Configure Avatar URL
7. Optional- Configure Include link to workflow
8. Optional- Configure Suppress notifications
9. Optional- Configure Embeds
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 an API that allows developers to quickly and easily create web
applications, websites, and mobile games without having to code. With
Xperiencify, developers can focus on creating a great product while leaving the
complexity of coding to the Xperiencify team.

Xperiencify allows developers to explore the possibilities of creating custom
projects such as interactive web applications, dynamic websites, and mobile
games. Through the Xperiencify API, developers have access to a variety of
tools and resources that are designed to support and simplify the process of
creating web and mobile applications.

Examples of projects you can build with the Xperiencify API include:

Java web applications
Interactive ecommerce websites
Responsive mobile websites
HTML5 mobile games
Mobile messaging applications
Social networking applications
Cloud managed services
Data-driven web applications
Mobile game server architecture

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#

Send Message (Advanced) on Discord

Description:Send a simple or structured message (using embeds) to a Discord channel

Version:1.0.2

Key:discord-send-message-advanced

View on GitHub

Discord Overview#

The Pipedream Discord app enables you to build event-driven workflows that interact with the Discord API. When you authorize the Pipedream app's access to your guilds, you can use Pipedream workflows to perform common Discord actions, or write your own code against the Discord API.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import common from "../common/common.mjs";

export default {
  ...common,
  key: "discord-send-message-advanced",
  name: "Send Message (Advanced)",
  description: "Send a simple or structured message (using embeds) to a Discord channel",
  version: "1.0.2",
  type: "action",
  props: {
    ...common.props,
    message: {
      propDefinition: [
        common.props.discord,
        "message",
      ],
      optional: true,
    },
    embeds: {
      propDefinition: [
        common.props.discord,
        "embeds",
      ],
    },
  },
  async run({ $ }) {
    const {
      message,
      avatarURL,
      threadID,
      username,
      includeSentViaPipedream,
      suppressNotifications,
      embeds: embedsProp,
    } = this;
    const embeds = embedsProp;

    if (!message && !embeds) {
      throw new ConfigurationError("This action requires at least 1 message OR embeds object. Please enter one or the other above.");
    }

    let content = message;
    if (includeSentViaPipedream) {
      if (embeds?.length) {
        embeds.push({
          "color": 16777215,
          "description": this.getSentViaPipedreamText(),
        });
      } else {
        content = this.appendPipedreamText(message ?? "");
      }
    }

    try {
      const resp = await this.discord.sendMessage(this.channel, {
        avatar_url: avatarURL,
        username,
        flags: this.getMessageFlags(suppressNotifications),
        embeds,
        content,
      }, {
        thread_id: threadID,
      });
      $.export("$summary", "Message sent successfully");
      return resp || {
        success: true,
      };
    } catch (err) {
      const unsentMessage = this.getUserInputProps();
      $.export("unsent", unsentMessage);
      throw err;
    }
  },
};

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
Discord	`discord`	`app`	This component uses the Discord app.
channel	`channel`	`$.discord.channel`
Message	`message`	`string`	Enter a simple message up to 2000 characters. This is the most commonly used field. However, it's optional if you pass embed content.
Thread ID	`threadID`	`string`	If provided, the message will be posted to this thread
Username	`username`	`string`	Overrides the current username of the webhook
Avatar URL	`avatarURL`	`string`	If used, it overrides the default avatar of the webhook. Note: Consecutive posts by the same username within 10 minutes of each other will not display updated avatar.
Include link to workflow	`includeSentViaPipedream`	`boolean`	Defaults to `true`, includes a link to this workflow at the end of your Discord message.
Suppress notifications	`suppressNotifications`	`boolean`	Defaults to `false`, sends the message as silent, triggers no notifications to clients.
Embeds	`embeds`	`any`	Optionally pass an array of embed objects. E.g., {{ [{"description":"Use markdown including Italic bold __underline__ ~~strikeout~~ [hyperlink](https://google.com) `code`"}] }}. To pass data from another step, enter a reference using double curly brackets (e.g., `{{steps.mydata.$return_value}}`). Tip: Construct the `embeds` array in a Node.js code step, return it, and then pass the return value to this step.

Action Authentication#

Discord uses OAuth authentication. When you connect your Discord account, Pipedream will open a popup window where you can sign into Discord and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Discord API.

Pipedream requests the following authorization scopes when you connect your account:

botemailidentifyguilds

Send Message (Advanced) with Discord API on Student Added to Course from Xperiencify API

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

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,000+apps by most popular

1
-
24
of
2,000+
apps by most popular