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 quiz within a specified course. It allows users to modify key details of a quiz such as its name, description, and due date. This operation is useful for educators or administrators who need to keep quizzes up-to-date without manually accessing the Canvas web interface.

Practical examples:

  • Changing the title of a quiz after initial creation.
  • Updating the quiz description to provide more detailed instructions.
  • Adjusting the due date to accommodate schedule changes.

Properties

Name Meaning
Course ID The unique identifier of the course that contains the quiz to be updated.
Quiz ID The unique identifier of the quiz to update.
Quiz Name The new or updated name/title of the quiz.
Quiz Description A textual description providing details or instructions about the quiz (optional).
Due Date The new due date and time for the quiz (optional).

Output

The node outputs a JSON object under the json field containing the response data from the Canvas API after updating the quiz. The structure typically includes the updated quiz details as returned by the API, confirming the successful update.

Example output structure:

{
  "data": {
    "id": "quizId",
    "name": "Updated Quiz Name",
    "description": "Updated description text",
    "due_at": "2024-07-01T23:59:00Z",
    ...
  }
}

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the Canvas LMS API.
  • Needs an API authentication token (API key credential) configured in n8n credentials for Canvas.
  • The Canvas API base URL and access token must be set in the node's credentials configuration.

Troubleshooting

  • Common issues:

    • Invalid or expired API token causing authentication failures.
    • Incorrect Course ID or Quiz ID leading to "not found" errors.
    • Missing required fields like Quiz Name resulting in validation errors.
    • Network connectivity problems preventing API calls.
  • Error messages and resolutions:

    • "Error in "quiz" operation "update": <message>": Indicates an issue during the update request; check the provided IDs and API credentials.
    • Authentication errors: Verify that the API token is valid and has sufficient permissions.
    • Validation errors: Ensure all required properties are correctly filled, especially the Quiz Name.
    • Rate limiting or API downtime: Retry after some time or check Canvas status.

Links and References

Discussion