Create Student with Teach 'n Go API on Daily schedule from Schedule API

Pipedream makes it easy to connect APIs for Teach 'n Go, Schedule and 2,200+ other apps remarkably fast.

Trigger workflow on

Daily schedule from the Schedule API

Next, do this

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

Select this integration
Configure the Daily schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Student action
1. Connect your Teach 'n Go account
2. Configure First Name
3. Configure Last Name
4. Optional- Select a Gender
5. Optional- Configure Registration Date
6. Optional- Configure Date Of Birth
7. Optional- Configure Identification Number
8. Optional- Select a Preferred Payment Method
9. Optional- Configure Discount Percentage
10. Optional- Configure Mobile Phone Code
11. Optional- Configure Mobile Phone
12. Optional- Configure Home Phone Code
13. Optional- Configure Home Phone
14. Optional- Configure Email Address
15. Optional- Configure Street Name And Number
16. Optional- Configure Flat Floor
17. Optional- Configure Area
18. Optional- Configure City
19. Optional- Configure Postcode
20. Optional- Configure Country Code
21. Optional- Configure General Notes
22. Optional- Configure Medical Notes
23. Optional- Select one or more Courses
24. Optional- Configure Enrolment Date
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#

Daily schedule on Schedule

Description:Trigger your workflow every day.

Version:0.0.1

Key:schedule-daily

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Daily schedule",
  version: "0.0.1",
  key: "schedule-daily",
  type: "source",
  description: "Trigger your workflow every day.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 11 * * *",
      },
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Student on Teach 'n Go

Description:Registers a new student in Teach 'n Go. [See the documentation](https://intercom.help/teach-n-go/en/articles/6807235-new-student-and-class-registration-api)

Version:0.0.1

Key:teach_n_go-create-student

View on GitHub

Action Code#

import { PAYMENT_METHOD_OPTIONS } from "../../common/constants.mjs";
import app from "../../teach_n_go.app.mjs";

export default {
  key: "teach_n_go-create-student",
  name: "Create Student",
  description: "Registers a new student in Teach 'n Go. [See the documentation](https://intercom.help/teach-n-go/en/articles/6807235-new-student-and-class-registration-api)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    firstName: {
      propDefinition: [
        app,
        "firstName",
      ],
      description: "The student's first name.",
    },
    lastName: {
      propDefinition: [
        app,
        "lastName",
      ],
      description: "The student's last name.",
    },
    gender: {
      propDefinition: [
        app,
        "gender",
      ],
      description: "The student's gender.",
      optional: true,
    },
    registrationDate: {
      type: "string",
      label: "Registration Date",
      description: "The student's registration date. **Format: YYYY-MM-DD**",
      optional: true,
    },
    dateOfBirth: {
      propDefinition: [
        app,
        "dateOfBirth",
      ],
      description: "The student's date of birth. **Format: YYYY-MM-DD**",
      optional: true,
    },
    identificationNumber: {
      type: "string",
      label: "Identification Number",
      description: "The external number to identify the student.",
      optional: true,
    },
    preferredPaymentMethod: {
      type: "integer",
      label: "Preferred Payment Method",
      description: "The payment method the student want to use.",
      options: PAYMENT_METHOD_OPTIONS,
      optional: true,
    },
    discountPercentage: {
      type: "string",
      label: "Discount Percentage",
      description: "The discount percentage on the payment amount.",
      optional: true,
    },
    mobilePhoneCode: {
      type: "integer",
      label: "Mobile Phone Code",
      description: "The region code of the mobile phone. Min length: 2, Max length: 4",
      optional: true,
    },
    mobilePhone: {
      type: "integer",
      label: "Mobile Phone",
      description: "The student's mobile phone",
      optional: true,
    },
    homePhoneCode: {
      type: "integer",
      label: "Home Phone Code",
      description: "The region code of the home phone. Min length: 2, Max length: 4",
      optional: true,
    },
    homePhone: {
      type: "integer",
      label: "Home Phone",
      description: "The student's home phone",
      optional: true,
    },
    emailAddress: {
      propDefinition: [
        app,
        "emailAddress",
      ],
      description: "The student's email address.",
      optional: true,
    },
    streetNameAndNumber: {
      type: "string",
      label: "Street Name And Number",
      description: "The student's full address.",
      optional: true,
    },
    flatFloor: {
      type: "string",
      label: "Flat Floor",
      description: "The student's address flat floor if it exists.",
      optional: true,
    },
    area: {
      type: "string",
      label: "Area",
      description: "The student's address area.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "The student's city.",
      optional: true,
    },
    postcode: {
      type: "string",
      label: "Postcode",
      description: "The student's postcode.",
      optional: true,
    },
    countryCode: {
      type: "string",
      label: "Country Code",
      description: "The student's ISO 2 letter country code, e.g. (US, UK, IN).",
      optional: true,
    },
    generalNotes: {
      type: "string",
      label: "General Notes",
      description: "Some student's additional notes.",
      optional: true,
    },
    medicalNotes: {
      type: "string",
      label: "Medical Notes",
      description: "Some student's additional medical notes.",
      optional: true,
    },
    courses: {
      propDefinition: [
        app,
        "courses",
      ],
      optional: true,
    },
    enrolmentDate: {
      type: "string",
      label: "Enrolment Date",
      description: "The date of the student's enrolment.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.app.registerStudent({
      $,
      data: {
        fname: this.firstName,
        lname: this.lastName,
        gender: this.gender,
        registration_date: this.registrationDate,
        date_of_birth: this.dateOfBirth,
        identification_number: this.identificationNumber,
        preferred_payment_method: this.preferredPaymentMethod,
        discount_percentage: this.discountPercentage && parseFloat(this.discountPercentage),
        mobile_phone_code: this.mobilePhoneCode,
        mobile_phone: this.mobilePhone,
        home_phone_code: this.homePhoneCode,
        home_phone: this.homePhone,
        email_address: this.emailAddress,
        street_name_and_number: this.streetNameAndNumber,
        flat_floor: this.flatFloor,
        area: this.area,
        city: this.city,
        postcode: this.postcode,
        country_code: this.countryCode,
        general_notes: this.generalNotes,
        medical_notes: this.medicalNotes,
        courses: this.courses,
        enrolment_date: this.enrolmentDate,
      },
    });

    $.export("$summary", `Successfully registered student with ID: ${response.data.id}`);
    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
Teach 'n Go	`app`	`app`	This component uses the Teach 'n Go app.
First Name	`firstName`	`string`	The student's first name.
Last Name	`lastName`	`string`	The student's last name.
Gender	`gender`	`string`	Select a value from the drop down menu:`FemaleMaleNot Specified`
Registration Date	`registrationDate`	`string`	The student's registration date. Format: YYYY-MM-DD
Date Of Birth	`dateOfBirth`	`string`	The student's date of birth. Format: YYYY-MM-DD
Identification Number	`identificationNumber`	`string`	The external number to identify the student.
Preferred Payment Method	`preferredPaymentMethod`	`integer`	Select a value from the drop down menu:`{ "label": "Cash", "value": 1 }{ "label": "Cheque", "value": 2 }{ "label": "Credit Card", "value": 3 }{ "label": "Bank Transfer", "value": 4 }{ "label": "Direct Debit", "value": 5 }`
Discount Percentage	`discountPercentage`	`string`	The discount percentage on the payment amount.
Mobile Phone Code	`mobilePhoneCode`	`integer`	The region code of the mobile phone. Min length: 2, Max length: 4
Mobile Phone	`mobilePhone`	`integer`	The student's mobile phone
Home Phone Code	`homePhoneCode`	`integer`	The region code of the home phone. Min length: 2, Max length: 4
Home Phone	`homePhone`	`integer`	The student's home phone
Email Address	`emailAddress`	`string`	The student's email address.
Street Name And Number	`streetNameAndNumber`	`string`	The student's full address.
Flat Floor	`flatFloor`	`string`	The student's address flat floor if it exists.
Area	`area`	`string`	The student's address area.
City	`city`	`string`	The student's city.
Postcode	`postcode`	`string`	The student's postcode.
Country Code	`countryCode`	`string`	The student's ISO 2 letter country code, e.g. (US, UK, IN).
General Notes	`generalNotes`	`string`	Some student's additional notes.
Medical Notes	`medicalNotes`	`string`	Some student's additional medical notes.
Courses	`courses`	`integer[]`	Select a value from the drop down menu.
Enrolment Date	`enrolmentDate`	`string`	The date of the student's enrolment.