Enroll Users in Courses with iSpring Learn API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Enroll Users in Courses with the iSpring Learn 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#

Create a workflow to Enroll Users in Courses with the iSpring Learn API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Enroll Users in Courses action
1. Connect your iSpring Learn account
2. Select one or more User ID
3. Select one or more Course ID
4. Optional- Configure Access Date
5. Optional- Configure Lock After Due Date
6. Select a Due Date Type
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Enroll Users in Courses with iSpring Learn API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + iSpring Learn

Try it

Enroll Users in Courses with iSpring Learn API on New Submission from Typeform API

Typeform + iSpring Learn

Try it

Enroll Users in Courses with iSpring Learn API on New Submission (Instant) from Jotform API

Jotform + iSpring Learn

Try it

Enroll Users in Courses with iSpring Learn API on New Scheduled Tasks from Pipedream API

Pipedream + iSpring Learn

Try it

Enroll Users in Courses with iSpring Learn API on npm Download Counts from npm API

npm + iSpring Learn

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Enroll Users in Courses on iSpring Learn

Description:Enrolls users to the specified courses on iSpring Learn.

Version:0.0.1

Key:ispring_learn-enroll-users-in-courses

View on GitHub

Code#

import { parseObject } from "../../common/utils.mjs";
import ispringLearn from "../../ispring_learn.app.mjs";

export default {
  key: "ispring_learn-enroll-users-in-courses",
  name: "Enroll Users in Courses",
  description: "Enrolls users to the specified courses on iSpring Learn.",
  version: "0.0.1",
  type: "action",
  props: {
    ispringLearn,
    userIds: {
      propDefinition: [
        ispringLearn,
        "userId",
      ],
      type: "string[]",
    },
    courseIds: {
      propDefinition: [
        ispringLearn,
        "courseIds",
      ],
    },
    accessDate: {
      type: "string",
      label: "Access Date",
      description: "The date and time when learners are supposed to start studying the course. If the start date and time aren't indicated, the current date and time will be auto-populated.",
      optional: true,
    },
    lockAfterDueDate: {
      type: "boolean",
      label: "Lock After Due Date",
      description: "This parameter indicates whether the course will be blocked after the due date.",
      optional: true,
    },
    dueDateType: {
      type: "string",
      label: "Due Date Type",
      description: "This parameter indicates whether the course has a due date or it isn't time-limited.",
      options: [
        {
          label: "Unlimited",
          value: "unlimited",
        },
        {
          label: "Default",
          value: "default",
        },
        {
          label: "Due Date",
          value: "due_date",
        },
        {
          label: "Pue Period",
          value: "due_period",
        },
      ],
      default: "default",
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.dueDateType === "due_date") {
      props.dueDate = {
        type: "string",
        label: "Due Date",
        description: "The limit date of the enrollment. Format: YYYY-MM-DDTHH:MM:SSZ",
      };
    }
    if (this.dueDateType === "due_period") {
      props.duePeriod = {
        type: "string",
        label: "Due Period",
        description: "The limit period of the enrollment. It is measured in hours.",
      };
    }
    return props;
  },
  async run({ $ }) {
    const response = await this.ispringLearn.enrollUser({
      $,
      data: {
        learnerIds: parseObject(this.userIds),
        courseIds: parseObject(this.courseIds),
        accessDate: this.accessDate,
        lockAfterDueDate: this.lockAfterDueDate,
        dueDateType: this.dueDateType,
        dueDate: this.dueDate,
        duePeriod: this.duePeriod,
      },
    });

    $.export("$summary", "Successfully enrolled users in courses");
    return response;
  },
};

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
iSpring Learn	`ispringLearn`	`app`	This component uses the iSpring Learn app.
User ID	`userIds`	`string[]`	Select a value from the drop down menu.
Course ID	`courseIds`	`string[]`	Select a value from the drop down menu.
Access Date	`accessDate`	`string`	The date and time when learners are supposed to start studying the course. If the start date and time aren't indicated, the current date and time will be auto-populated.
Lock After Due Date	`lockAfterDueDate`	`boolean`	This parameter indicates whether the course will be blocked after the due date.
Due Date Type	`dueDateType`	`string`	Select a value from the drop down menu:`{ "label": "Unlimited", "value": "unlimited" }{ "label": "Default", "value": "default" }{ "label": "Due Date", "value": "due_date" }{ "label": "Pue Period", "value": "due_period" }`

Authentication#

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

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