How Do I Configure Live Events for Canvas Data?

Document created by Sydney McCann Employee on Mar 15, 2017Last modified by Sydney McCann Employee on Oct 31, 2017
Version 9Show Document
  • View in full screen mode

This feature is currently in BETA with a TBD release date for PROD

 

What is Live Events?

Live Events is a feature within Canvas that allows certain activities, or events, to emit messages in real time from a defined list of Canvas actions. Live Events are formatted in the IMS Caliper 1.1 format. Institutions interested in receiving Live Events must be able to accept the IMS Caliper 1.1 formatted events through an AWS SQS queue.

 

How Do I Start to Receive Live Events?

In order to receive Live Events, you will need to do the following:

 

Step 1: Configure AWS SQS

We do not support FIFO (.fifo) queues since Live Events is architected already to order the data before sending.


1) Create a new SQS queue

 

 

2) When naming your new SQS queue, ensure that the name BEGINS with the text 'canvas-live-events'

 


3) Give Instructure's AWS account access to your SQS queue by adding the following permission (Queue Actions -> Add a New Permission) to your SQS policy: Resource: arn:aws:sqs:us-east-1:<your aws account id>:<queue name>

A full example of an SQS policy that grants cross-account access looks like this:

{
   "Version": "2012-10-17",
   "Statement": [
{
   "Effect": "Allow",
   "Principal": {
      "AWS": "arn:aws:iam::636161780776:root"
},
   "Action": "SQS:*",
   "Resource": "arn:aws:sqs:us-east-1:<your account id>:canvas-live-events"
      }
   ]
}

 

Step 2: Configure Live Events in Canvas Data Portal

 

1. In Account Navigation, click the Canvas Data Portal link.

Open Canvas Data Portal

 

2. Select the "Live Events" Tab at the top of the page

 

3. Give your subscription a name and provide your SQS URL

Add SQS URL for Live Events Feed

 

4. Decide which subscriptions you would like to receive.

Decide Which Events You Want to Receive.

 

5. Select "Create" at the bottom of the page to save your settings

 

 

Event Points Currently in Live Events

List of current subscriptions can be found here: Live Events (experimental) - Canvas LMS REST API Documentation 

4 people found this helpful

Attachments

    Outcomes