Create Workspace with Airbyte API on New Assignment from Google Classroom API

Pipedream makes it easy to connect APIs for Airbyte, Google Classroom and 2,400+ other apps remarkably fast.

Trigger workflow on

New Assignment from the Google Classroom API

Next, do this

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

Select this integration
Configure the New Assignment trigger
1. Connect your Google Classroom account
2. Configure timer
3. Optional- Select one or more Course States
4. Select a Course
5. Optional- Configure Keywords
Configure the Create Workspace action
1. Connect your Airbyte account
2. Configure Workspace name
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#

New Assignment on Google Classroom

Description:Emit new event when an assignment is added to a course.

Version:0.0.4

Key:google_classroom-new-assignment

View on GitHub

Google Classroom Overview#

The Google Classroom API lets you tap into the educational space by managing courses, assignments, and student interactions programmatically. With this API, you can automate course creation, roster management, and content distribution, effectively bridging the gap between various educational tools and platforms. Leveraging Pipedream's serverless execution environment, you can build powerful workflows that respond to events in Classroom, sync data across platforms, and streamline the educational process for teachers and students alike.

Trigger Code#

import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "google_classroom-new-assignment",
  name: "New Assignment",
  description: "Emit new event when an assignment is added to a course.",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    keywords: {
      type: "string[]",
      label: "Keywords",
      description: "Limit the results to assignments that contain keywords",
      optional: true,
      reloadProps: true,
    },
  },
  async additionalProps() {
    if (this.keywords?.length > 0) {
      return {
        searchDescription: {
          type: "boolean",
          label: "Search Title & Description?",
          description: "Set to `true` to search both title and description for keyword(s). If `false`, only assignment titles will be searched",
          optional: true,
          default: false,
        },
      };
    }
  },
  methods: {
    ...common.methods,
    async getHistoricalEvents({ pageSize }) {
      const { courseWork } = await this.googleClassroom.listCoursework({
        ...this.getParams(),
        pageSize,
      });
      return courseWork;
    },
    async getResults(after) {
      return this.paginate(this.googleClassroom.listCoursework, this.getParams(), "courseWork", after);
    },
    getParams() {
      return {
        courseId: this.course,
        courseWorkStates: this.courseStates,
      };
    },
    isRelevant(assignment, after = null) {
      if (!this.isAfter(assignment.creationTime, after)) {
        return false;
      }
      if (this.keywords?.length > 0) {
        const titleMatch = this.keywordsMatch(assignment.title);
        if (this.searchDescription) {
          const descriptionMatch = this.keywordsMatch(assignment?.description);
          return titleMatch || descriptionMatch;
        } else {
          return titleMatch;
        }
      }
      return true;
    },
    keywordsMatch(text = "") {
      const matches = this.keywords?.filter((keyword) => text.includes(keyword));
      return matches.length > 0;
    },
    generateMeta(assignment) {
      return {
        id: assignment.id,
        summary: `New assignment ${assignment.title}`,
        ts: Date.parse(assignment.creationTime),
      };
    },
  },
  sampleEmit,
};

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
Google Classroom	`googleClassroom`	`app`	This component uses the Google Classroom app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Course States	`courseStates`	`string[]`	Select a value from the drop down menu:`COURSE_STATE_UNSPECIFIEDACTIVEARCHIVEDPROVISIONEDDECLINEDSUSPENDED`
Course	`course`	`string`	Select a value from the drop down menu.
Keywords	`keywords`	`string[]`	Limit the results to assignments that contain keywords

Trigger Authentication#

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

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

https://www.googleapis.com/auth/userinfo.emailhttps://www.googleapis.com/auth/userinfo.profilehttps://www.googleapis.com/auth/classroom.courses.readonlyhttps://www.googleapis.com/auth/classroom.coursework.studentshttps://www.googleapis.com/auth/classroom.coursework.mehttps://www.googleapis.com/auth/classroom.announcements.readonly

About Google Classroom#

Google Classroom helps educators create engaging learning experiences they can personalize, manage, and measure.

Action#

Create Workspace on Airbyte

Description:Creates a workspace on Airbyte. [See the documentation](https://reference.airbyte.com/reference/createworkspace)

Version:0.0.1

Key:https_airbyte_com-create-workspace

View on GitHub

Airbyte Overview#

The Airbyte API allows for creating and managing data integration pipelines between various sources and destinations, automating data synchronization tasks, and monitoring the status of those pipelines. On Pipedream, you can leverage the Airbyte API to build intricate workflows that react to data events, manipulate and store data, and connect to other services to create rich, automated data pipelines.

Action Code#

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

export default {
  key: "https_airbyte_com-create-workspace",
  name: "Create Workspace",
  description: "Creates a workspace on Airbyte. [See the documentation](https://reference.airbyte.com/reference/createworkspace)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    name: {
      propDefinition: [
        app,
        "name",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.app.createWorkspace({
      $,
      data: {
        name: this.name,
      },
    });
    $.export("$summary", `Successfully created the ${response.name} workspace`);
    return response;
  },
};