Update Assignment with Canvas API on New Bot Command Received (Instant) from Telegram API

Pipedream makes it easy to connect APIs for Canvas, Telegram and 3,000+ other apps remarkably fast.

Trigger workflow on

New Bot Command Received (Instant) from the Telegram API

Next, do this

Update Assignment with the Canvas 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 Telegram trigger and Canvas action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Bot Command Received (Instant) trigger
1. Connect your Telegram account
2. Select one or more Commands
Configure the Update Assignment action
1. Connect your Canvas account
2. Select a Account ID
3. Select a User ID
4. Select a Course ID
5. Select a Assignment ID
6. Optional- Configure Name
7. Optional- Configure Description
8. Optional- Select a Submission Type
9. Optional- Configure Notify of Update
10. Optional- Configure Points Possible
11. Optional- Select a Grading Type
12. Optional- Configure Due At
13. Optional- Configure Omit From Final Grade
14. Optional- Configure Allowed Attempts
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 Bot Command Received (Instant) on Telegram

Description:Emit new event each time a Telegram Bot command is received.

Version:0.0.5

Key:telegram_bot_api-new-bot-command-received

View on GitHub

New Bot Command Received (Instant) Overview#

Telegram Bots can respond to Slash commands. For instance, you can add a /hi or /help command to your Telegram bot to help users learn how to use your bot.

Trigger Code#

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

export default {
  ...base,
  key: "telegram_bot_api-new-bot-command-received",
  name: "New Bot Command Received (Instant)",
  description: "Emit new event each time a Telegram Bot command is received.",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...base.props,
    commands: {
      propDefinition: [
        base.props.telegramBotApi,
        "commands",
      ],
    },
  },
  methods: {
    ...base.methods,
    getMeta(event, message) {
      return {
        id: event.update_id,
        summary: message.text,
        ts: new Date(message.edit_date ?? message.date),
      };
    },
    getEventTypes() {
      return [
        "message",
        "edited_message",
      ];
    },
    processEvent(event) {
      const message = event.edited_message ?? event.message;

      if (!message?.text) {
        console.log("Skipping message that isn’t a bot command");

        return;
      }

      const command = message.text.split(" ")[0];

      if (typeof this.commands === "string") {
        this.commands = JSON.parse(this.commands);
      }

      const foundCmd = this.commands.some((cmd) => command.includes(cmd));
      if (!foundCmd) {
        return;
      }

      this.$emit(event, this.getMeta(event, message));
    },
  },
  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
Telegram	`telegramBotApi`	`app`	This component uses the Telegram app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Commands	`commands`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

Telegram uses API keys for authentication. When you connect your Telegram account, Pipedream securely stores the keys so you can easily authenticate to Telegram APIs in both code and no-code steps.

About Telegram#

Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.

Action#

Update Assignment on Canvas

Description:Update an assignment. [See the documentation](https://mitt.uib.no/doc/api/all_resources.html#method.assignments_api.update)

Version:0.0.1

Key:canvas-update-assignment

View on GitHub

Canvas Overview#

The Canvas API allows you to tap into the power of the Canvas Learning Management System, enabling educators and administrators to automate tasks, synchronize educational tools, and manage courses and users programmatically. It provides endpoints for accessing course information, user details, assignments, and more, which can be incredibly useful for creating customized educational experiences and streamlining administrative workflows. With Pipedream, you can harness these capabilities to trigger actions, connect with other apps and services, and create complex automations without writing extensive code.

Action Code#

import canvas from "../../canvas.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import constants from "../../common/constants.mjs";

export default {
  key: "canvas-update-assignment",
  name: "Update Assignment",
  description: "Update an assignment. [See the documentation](https://mitt.uib.no/doc/api/all_resources.html#method.assignments_api.update)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    canvas,
    accountId: {
      propDefinition: [
        canvas,
        "accountId",
      ],
    },
    userId: {
      propDefinition: [
        canvas,
        "userId",
        (c) => ({
          accountId: c.accountId,
        }),
      ],
    },
    courseId: {
      propDefinition: [
        canvas,
        "courseId",
        (c) => ({
          userId: c.userId,
        }),
      ],
    },
    assignmentId: {
      propDefinition: [
        canvas,
        "assignmentId",
        (c) => ({
          courseId: c.courseId,
          userId: c.userId,
        }),
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the assignment",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the assignment, supports HTML",
      optional: true,
    },
    submissionType: {
      type: "string",
      label: "Submission Type",
      description: "The type of submission for the assignment",
      options: constants.SUBMISSION_TYPES,
      optional: true,
    },
    notifyOfUpdate: {
      type: "boolean",
      label: "Notify of Update",
      description: "Whether to notify the students of the update",
      optional: true,
    },
    pointsPossible: {
      type: "integer",
      label: "Points Possible",
      description: "The maximum points possible on the assignment",
      optional: true,
    },
    gradingType: {
      type: "string",
      label: "Grading Type",
      description: "The strategy used for grading the assignment. The assignment defaults to “points” if this field is omitted.",
      options: constants.GRADING_TYPES,
      optional: true,
    },
    dueAt: {
      type: "string",
      label: "Due At",
      description: "The day/time the assignment is due. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.",
      optional: true,
    },
    omitFromFinalGrade: {
      type: "boolean",
      label: "Omit From Final Grade",
      description: "Whether this assignment is counted towards a student's final grade.",
      optional: true,
    },
    allowedAttempts: {
      type: "integer",
      label: "Allowed Attempts",
      description: "The number of submission attempts allowed for this assignment. Set to -1 for unlimited attempts.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (
      !this.name
      && !this.description
      && !this.submissionType
      && !this.notifyOfUpdate
      && !this.pointsPossible
      && !this.gradingType
      && !this.dueAt
      && !this.omitFromFinalGrade
      && !this.allowedAttempts
    ) {
      throw new ConfigurationError("At least one field must be provided to update the assignment");
    }

    const assignment = await this.canvas.updateAssignment({
      $,
      courseId: this.courseId,
      assignmentId: this.assignmentId,
      data: {
        assignment: {
          name: this.name,
          description: this.description,
          submission_types: this.submissionType
            ? [
              this.submissionType,
            ]
            : undefined,
          notify_of_update: this.notifyOfUpdate,
          points_possible: this.pointsPossible,
          grading_type: this.gradingType,
          due_at: this.dueAt,
          omit_from_final_grade: this.omitFromFinalGrade,
          allowed_attempts: this.allowedAttempts,
        },
      },
    });
    $.export("$summary", `Successfully updated assignment with ID: '${this.assignmentId}'`);
    return assignment;
  },
};

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
Canvas	`canvas`	`app`	This component uses the Canvas app.
Account ID	`accountId`	`string`	Select a value from the drop down menu.
User ID	`userId`	`string`	Select a value from the drop down menu.
Course ID	`courseId`	`string`	Select a value from the drop down menu.
Assignment ID	`assignmentId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the assignment
Description	`description`	`string`	The description of the assignment, supports HTML
Submission Type	`submissionType`	`string`	Select a value from the drop down menu:`online_quiznoneon_paperdiscussion_topicexternal_toolonline_uploadonline_text_entryonline_urlmedia_recordingstudent_annotation`
Notify of Update	`notifyOfUpdate`	`boolean`	Whether to notify the students of the update
Points Possible	`pointsPossible`	`integer`	The maximum points possible on the assignment
Grading Type	`gradingType`	`string`	Select a value from the drop down menu:`pass_failpercentletter_gradegpa_scalepointsnot_graded`
Due At	`dueAt`	`string`	The day/time the assignment is due. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
Omit From Final Grade	`omitFromFinalGrade`	`boolean`	Whether this assignment is counted towards a student's final grade.
Allowed Attempts	`allowedAttempts`	`integer`	The number of submission attempts allowed for this assignment. Set to -1 for unlimited attempts.

Action Authentication#

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

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