Canvas LMS icon

Canvas LMS

Work with Canvas LMS API and receive events

Overview

This node integrates with the Canvas LMS API to update an existing assignment within a specified course. It allows users to modify key details of an assignment such as its name, description, maximum points possible, and due date. This is useful in educational workflows where assignments need to be updated programmatically based on changes in course structure or requirements.

Practical examples:

  • Automatically updating assignment details when course content changes.
  • Synchronizing assignment information from another system into Canvas.
  • Adjusting due dates or point values for assignments in bulk via automation.

Properties

Name Meaning
Course ID The unique identifier of the course containing the assignment to update.
Assignment ID The unique identifier of the assignment to update.
Assignment Name The new or updated name/title of the assignment.
Assignment Description A detailed description or instructions for the assignment (supports rich text).
Points Possible The maximum number of points that can be earned on the assignment.
Due Date The deadline by which the assignment must be submitted (date and time).

Output

The node outputs a JSON object under the json field containing the updated assignment data returned from the Canvas API. This typically includes all properties of the assignment after the update, such as its ID, name, description, points possible, due date, and other metadata provided by Canvas.

No binary data output is produced by this operation.

Example output structure:

{
  "data": {
    "id": "123",
    "name": "Updated Assignment Name",
    "description": "Updated description here",
    "points_possible": 100,
    "due_at": "2024-07-01T23:59:00Z",
    ...
  }
}

Dependencies

  • Requires an active connection to the Canvas LMS API.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The Canvas API base URL and access token must be set in the credentials.
  • The node uses HTTP methods (PUT) to update assignment resources via the Canvas REST API.

Troubleshooting

  • Common issues:

    • Invalid or missing Course ID or Assignment ID will cause the API call to fail.
    • Insufficient permissions or invalid API token may result in authorization errors.
    • Incorrect date format for the due date can cause request validation errors.
  • Error messages:

    • "Error in "assignment" operation "update": <message>" indicates a failure during the update process; check the message for specifics.
    • API errors related to authentication or resource not found should be resolved by verifying credentials and IDs.
  • Resolution tips:

    • Ensure all required fields are correctly filled.
    • Verify the API token has sufficient rights to update assignments.
    • Confirm the assignment exists in the specified course before attempting update.
    • Use ISO 8601 format for date/time inputs.

Links and References

Discussion