Beyond-Bot.ai Logo+canvas Logo

Beyond-Bot.ai + canvas

Canvas is a learning management system supporting online courses, assignments, grading, and collaboration, widely used by schools and universities for virtual classrooms

What You Can Do with this Integration

Automate Data Entry

Automatically sync new contacts or deals from Beyond-Bot.ai to canvas.

Enrich Customer Profiles

Use Beyond-Bot.ai to find and add new information to your records in canvas.

Trigger Workflows

Start automated workflows in canvas based on conversations with your virtual expert.

Available Actions

Here are the specific actions your virtual expert can perform within canvas.

Create Account Notification

Creates a global notification within a canvas account, ensuring `end at` is after `start at` and any specified `notification roles` are valid.

Create Appointment Group

Creates a new appointment group in canvas for schedulable time slots within specified course or group contexts.

Create An Assignment

Creates a new assignment within a specified course in canvas lms.

Create Assignment Override

Creates an assignment override to adjust due/unlock/lock dates for an assignment in a course, targeting specific students (requires `title`), a group, or a course section; at least one target (`student ids`, `group id`, or `course section id`) is required.

Create Calendar Event

Creates a calendar event with options for recurrence (finite `rrule` series only), section-specific timings, and blackout dates within a specified context.

Create Communication Channel

Creates a new communication channel (e.g., email, sms, push) for an existing canvas user to receive notifications.

Create Content Share

Shares a canvas content item to specified users, if the sender has necessary permissions and receiver ids are valid.

Create Conversation

Use to send messages in canvas by creating a new conversation or adding to an existing one; an existing conversation with the same recipients (and matching scope/filter, if specified) may be reused unless `force new` is true.

Create A Course

Creates a new course in canvas within a specified account, with comprehensive configuration options.

Create Discussion Entry

Tool to create a new entry in a canvas discussion topic. use when posting a message with optional attachments to a discussion topic.

Create Discussion Topic

Creates a new discussion topic in a specified canvas course, allowing comprehensive configuration of its content, type, publication settings, engagement features, and associations.

Create Enrollment

Enrolls a user in a canvas course with a specified role and status; `associated user id` is required if `enrollment type` is 'observerenrollment'.

Create Folder

Creates a new folder in canvas within a specified context (e.g., course, user) and optional parent folder; ensure the context and any parent folder (specified by id or path, not both) already exist.

Create Module

Creates a new organizational module within a specified canvas lms course, with options for availability, sequencing, and prerequisites.

Create A Page For A Course

Creates a new wiki page in a specified canvas course, with options for title, html body, editing permissions, publication, and designation as front page (which also requires publication).

Create Quiz

Creates a new quiz with various settings in a specified existing canvas course; `assignment group id` applies only to graded quiz types.

Create A Quiz Question

Creates a new question for an existing quiz within a course; if `answers` are provided, their structure must align with `question type`, and any `quiz group id` must be valid for an existing group in the quiz.

Delete Appointment Group

Permanently deletes an existing appointment group by its id; associated appointments may also be canceled or affected.

Delete An Assignment

Soft-deletes a specific assignment within a course, returning the assignment object with its `workflow state` updated to 'deleted'.

Delete A Folder

Permanently deletes an existing folder specified by its unique id.

Delete Quiz

Permanently deletes the quiz identified by `quiz id` from the course identified by `course id`; this action cannot be undone.

Get Current Grades

Fetches current, aggregated grade data from canvas analytics for a specified account id.

Get Term Grade Data

Retrieves department-level aggregated grade data for a specific academic term within a canvas account.

Edit Assignment

Updates an existing assignment in a canvas course (identified by `course id` and `assignment id`); only attributes explicitly provided in the request are modified.

Edit A Quiz

Modifies an existing canvas quiz; only attributes with provided values in the request are updated.

Export Content

Use to initiate an asynchronous export of content (e.g., common cartridge, qti, zip) from an existing canvas course, returning an export id and progress url.

Fetch Data

Fetches a specific category of canvas data (e.g., accounts, courses, users) by setting exactly one `get *` boolean flag to true and providing any associated ids. supports pagination with per page (default 100, max 100) and page (default 1) parameters to fetch large datasets.

Get Canvas Accounts

Retrieves all canvas accounts accessible to the authenticated user.

Get All Assignments

Retrieves assignments for a specified canvas course.

Get All Users

Retrieves a list of users for a specified canvas `account id` (use 'self' for the current user's root account), supporting filtering, sorting, and pagination.

Get Assignment

Retrieves detailed information for a specific assignment within a given course in canvas.

Get Assignment Rubric

Fetches the detailed rubric for a specified assignment within a canvas course; fails if the assignment has no associated rubric.

Get Course Activity

Retrieves daily activity analytics, such as page views and participation events, for a specified canvas course.

Get Current User

Retrieves detailed information about the currently authenticated user from the canvas lms.

Get Department-Level Completed Statistics

Retrieves numeric statistics for all completed courses for a specified canvas account id; the account must exist.

Get Department Level Current Statistics

Fetches a snapshot of current numerical statistics for a canvas account, requiring its valid id.

Get Department Level Completed Grades

Retrieves the distribution of final grades (0-100, binned to whole numbers) for all completed courses in a canvas account, where each data point represents one student's final grade in one course.

Get Department Level Term Statistics

Retrieves department-level academic term statistics (e.g., enrollment, activity, grades) for a specified account and term in canvas, provided analytics data is available.

Get Enrollment By Id

Retrieves a specific enrollment by its id within a given account.

Get Gradebook History Days

Retrieves a chronological list of dates with grading activity and the active graders for a specified course.

Get Page For A Course

Retrieves a specific content page (wiki or content page) by its url or numeric id from a specified canvas course.

Get Quiz Submissions

Retrieves all submissions for a specific quiz within a course; ensure `course id` and `quiz id` are valid and the quiz belongs to the course.

Get Report Status

Retrieves the status of a previously initiated report in a canvas account, specified by its type and id.

Get A Single Course

Retrieves detailed information for a specific canvas course using its `course id`, which must be valid, and allows for including additional data fields in the response via the `include` parameter.

Get Single Submission

Retrieves a specific submission for an assignment made by a particular user within a designated course.

Get Submission Files

Retrieves files from a student's canvas assignment submission, processing text, binary, and zip files, and providing s3 download urls if s3 integration is active and uploads are successful.

Get User Assignment Analytics

Fetches detailed assignment-level analytics for a specific student in a designated course, including submission details and class performance statistics.

Get User Course Progress

Retrieves the academic progress of a specific user within a given course.

Get User Participation Analytics

Retrieves page view activity and participation details for a specific student enrolled in a designated course.

Get User Profile

Retrieves profile information for an existing canvas user.

Grade Or Comment On A Submission

Updates a student's assignment submission with a grade, comment, sticker, or status change; requires `course id`, `assignment id`, `user id`, and at least one update field.

List Accounts For Course Admins

Retrieves canvas accounts visible to the current user due to their course-level administrative roles; no request parameters are needed.

List All Folders

Retrieves the first page of folders for a specified canvas course id; this action is scoped to courses only.

List Appointment Groups

Retrieves a list of canvas appointment groups based on specified filters; any provided `context codes` must be valid and accessible by the user.

List Assignment Submissions

Retrieves submissions for a specific assignment within a course, optionally including related resources or grouping by student group for group assignments. supports pagination to retrieve more than the default 10 submissions.

List Available Reports

Lists available reports (including those that can be or have been generated) for a valid canvas account id.

List Calendar Events For A User

Retrieves calendar events and assignments for a specific user from canvas lms, supporting extensive filtering options detailed in the request schema.

List Communication Messages

Retrieves communication messages from canvas.

List Communication Channels

Retrieves a list of communication channels associated with a specific user in canvas.

List Content Exports

Retrieves a paginated list of content exports from canvas for a specified, existing course.

List Courses

Retrieves a list of the current user's courses from canvas, optionally filtered by enrollment type and state.

List Courses For A User

Retrieves a list of courses in canvas for a specified `user id`, requiring observer or admin permissions to view courses for others.

List Course Users

Retrieves a paginated list of users for a given canvas `course id` (which must be an existing course), supporting various filtering, sorting, and data inclusion options.

List Discussion Entries

Tool to retrieve paginated discussion entries for a specific discussion topic in a course. use when needing to list all posts and replies under a given topic, supports pagination.

List Discussion Topics

Retrieves a paginated list of discussion topics or announcements for a specified course.

List Files

Fetches metadata (id, name, size, type, urls) for all files within a specified canvas course.

List Folders

Retrieves a list of immediate sub-folders within the specified `folder id`.

List Pages For A Course

Retrieves a list of wiki pages associated with a specific, existing course in canvas.

List Quizzes In Course

Retrieves a paginated list of quizzes for a specified, valid canvas course, optionally filtering by a search term in the quiz title.

List Sent Content Shares

Retrieves content shares sent by the specified user to other users or courses within canvas.

List Submissions

Fetches gradebook history submissions for a specific course, assignment, grader, and date from canvas.

List Submissions For Multiple Assignments

Retrieves submissions from a canvas course for specified assignments and/or students; the course must be accessible.

List Uncollated Submission Versions

Retrieves a feed of uncollated submission versions from the gradebook history for a course; any provided `assignment id` must be valid for the course, and any `user id` must be for a user enrolled in the course.

List Users In Account

Use this action to retrieve all users associated with a specific, existing canvas account id.

Reply To Discussion Entry

Tool to reply to a discussion entry. use when you need to send a message to a discussion entry with optional attachments.

Retrieve Enrollment Term

Retrieves detailed information for a specific enrollment term within a given root account in canvas.

Start A Report

Initiates an asynchronous report generation for a canvas account, using a valid report type for the account; the response confirms initiation and may include progress tracking details.

Translate File Reference

Resolves a file's migration id to its current representation within a specific canvas course.

Update Appointment Group

Updates an existing canvas appointment group by its id; only provided fields are modified, but `publish` defaults to `false` if omitted. the `appointment group id` must be valid.

Update Course

Updates an existing course, specified by its id, with new attributes or triggers a lifecycle event like 'conclude' or 'delete'.

Update Course Settings

Updates various settings for an existing course in canvas, identified by `course id`.

Update File

Modifies an existing file's name or relocates it to a new parent folder; the target folder, if specified, must be valid and in the file's original context.

Update Page For A Course

Updates an existing wiki page in a canvas course; if setting as front page, it must also be or be made published.

Update Quiz Submission Scores

Updates scores, comments for questions, and/or applies fudge points to a specific quiz submission attempt; the attempt must be completed and referenced by valid, existing course, quiz, and submission ids.

Update User Settings

Updates a canvas user's preferences for various interface elements and content interaction behaviors.

Upload A Course File

Uploads a file to an accessible canvas course, optionally to a specific folder (created if a non-existent `parent folder path` is provided) and with defined behavior for duplicate filenames.

Upload Submission File

Uploads a submission file for an assignment in a canvas course for a specified `user id`; this user must be enrolled, the assignment open for them, and 'masquerade' permissions may be needed if `user id` isn't 'self'.