Search Course Content with Canvas API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Search Course Content 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#

Create a workflow to Search Course Content with the Canvas API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Search Course Content action
1. Connect your Canvas account
2. Select a Account ID
3. Select a User ID
4. Select a Course ID
5. Configure Query
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

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.

Search Course Content on Canvas

Description:Search for content in a course. [See the documentation](https://mitt.uib.no/doc/api/all_resources.html#method.smart_search.search)

Version:0.0.1

Key:canvas-search-course-content

View on GitHub

Code#

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

export default {
  key: "canvas-search-course-content",
  name: "Search Course Content",
  description: "Search for content in a course. [See the documentation](https://mitt.uib.no/doc/api/all_resources.html#method.smart_search.search)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    canvas,
    accountId: {
      propDefinition: [
        canvas,
        "accountId",
      ],
    },
    userId: {
      propDefinition: [
        canvas,
        "userId",
        (c) => ({
          accountId: c.accountId,
        }),
      ],
    },
    courseId: {
      propDefinition: [
        canvas,
        "courseId",
        (c) => ({
          userId: c.userId,
        }),
      ],
    },
    query: {
      type: "string",
      label: "Query",
      description: "The query to search for",
    },
  },
  async run({ $ }) {
    const results = await this.canvas.searchCourseContent({
      $,
      courseId: this.courseId,
      params: {
        q: this.query,
      },
    });
    $.export("$summary", `${results.length} result${results.length > 1
      ? "s"
      : ""} were found.`);
    return results;
  },
};

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
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.
Query	`query`	`string`	The query to search for

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: