Create Post with Brilliant Directories API on New Assignment from Google Classroom API

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

Trigger workflow on

New Assignment from the Google Classroom API

Next, do this

Create Post with the Brilliant Directories 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 Brilliant Directories 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 Post action
1. Connect your Brilliant Directories account
2. Configure User ID
3. Configure Data ID
4. Configure Data Type
5. Configure Post Title
6. Optional- Configure Post Content
7. Optional- Configure Post Category
8. Optional- Configure Post Type
9. Optional- Configure Post Tags
10. Optional- Configure Post Status
11. Optional- Configure Post Start 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#

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 Post on Brilliant Directories

Description:Creates a single or group post. [See the documentation](https://support.brilliantdirectories.com/support/solutions/articles/12000093239-member-posts-api-create-update-delete-and-get-member-posts)

Version:0.0.1

Key:brilliant_directories-create-post

View on GitHub

Brilliant Directories Overview#

The Brilliant Directories API lets you tap into the functionality of your directory software, enabling you to automate tasks, manage listings, users, and more. With Pipedream, you can build serverless workflows integrating the Brilliant Directories API to streamline operations, sync data across platforms, and react to events in real-time.

Action Code#

import qs from "qs";
import app from "../../brilliant_directories.app.mjs";

export default {
  key: "brilliant_directories-create-post",
  name: "Create Post",
  description: "Creates a single or group post. [See the documentation](https://support.brilliantdirectories.com/support/solutions/articles/12000093239-member-posts-api-create-update-delete-and-get-member-posts)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    userId: {
      propDefinition: [
        app,
        "userId",
      ],
    },
    dataId: {
      propDefinition: [
        app,
        "dataId",
      ],
    },
    dataType: {
      propDefinition: [
        app,
        "dataType",
      ],
    },
    postTitle: {
      propDefinition: [
        app,
        "postTitle",
      ],
    },
    postContent: {
      propDefinition: [
        app,
        "postContent",
      ],
      optional: true,
    },
    postCategory: {
      propDefinition: [
        app,
        "postCategory",
      ],
      optional: true,
    },
    postType: {
      propDefinition: [
        app,
        "postType",
      ],
      optional: true,
    },
    postTags: {
      propDefinition: [
        app,
        "postTags",
      ],
      optional: true,
    },
    postStatus: {
      propDefinition: [
        app,
        "postStatus",
      ],
      optional: true,
    },
    postStartDate: {
      propDefinition: [
        app,
        "postStartDate",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.app.createPost({
      data: qs.stringify({
        user_id: this.userId,
        data_id: this.dataId,
        data_type: this.dataType,
        post_title: this.postTitle,
        post_content: this.postContent,
        post_category: this.postCategory,
        post_type: this.postType,
        post_tags: this.postTags && this.postTags.toString(),
        post_status: +this.postStatus,
        post_start_date: this.postStartDate,
      }),
    });

    $.export("$summary", `Successfully created post with ID: ${response.message?.post_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
Brilliant Directories	`app`	`app`	This component uses the Brilliant Directories app.
User ID	`userId`	`integer`	The unique identifier for a user.
Data ID	`dataId`	`integer`	The data id for the post.
Data Type	`dataType`	`integer`	The data type for the post.
Post Title	`postTitle`	`string`	The title of the post.
Post Content	`postContent`	`string`	The content of the post.
Post Category	`postCategory`	`string`	The category of the post.
Post Type	`postType`	`string`	The type of the post.
Post Tags	`postTags`	`string[]`	A list of tags to the post.
Post Status	`postStatus`	`boolean`	The status of the post.
Post Start Date	`postStartDate`	`string`	The start date of the post. Format yyyymmddhhmmss