Add Email to Global Suppression with Twilio SendGrid API on Student Added to Course from Xperiencify API

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

Trigger workflow on

Student Added to Course from the Xperiencify API

Next, do this

Add Email to Global Suppression with the Twilio SendGrid 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 Twilio SendGrid 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 Add Email to Global Suppression action
1. Connect your Twilio SendGrid account
2. Configure Recipient Emails
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#

Add Email to Global Suppression on Twilio SendGrid

Description:Allows you to add one or more email addresses to the global suppressions group. [See the docs here](https://sendgrid.api-docs.io/v3.0/suppressions-global-suppressions/add-recipient-addresses-to-the-global-suppression-group)

Version:0.0.3

Key:sendgrid-add-email-to-global-suppression

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Action Code#

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

export default {
  ...common,
  key: "sendgrid-add-email-to-global-suppression",
  name: "Add Email to Global Suppression",
  description: "Allows you to add one or more email addresses to the global suppressions group. [See the docs here](https://sendgrid.api-docs.io/v3.0/suppressions-global-suppressions/add-recipient-addresses-to-the-global-suppression-group)",
  version: "0.0.3",
  type: "action",
  props: {
    ...common.props,
    recipientEmails: {
      type: "string[]",
      label: "Recipient Emails",
      description: "An array of email addresses to be added to the global suppressions group. Example `[\"email1@example.com\",\"email2@example.com\"]`",
    },
  },
  async run({ $ }) {
    const resp = await this.sendgrid.addEmailToGlobalSuppression(this.recipientEmails);
    $.export("$summary", "Successfully added emails to global suppressions group");
    return resp;
  },
};

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
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
Recipient Emails	`recipientEmails`	`string[]`	An array of email addresses to be added to the global suppressions group. Example `["email1@example.com","email2@example.com"]`