Currently, we only collect Assignments, Submissions and Comments. Naturally, we do retrieve all the relevant Course and User data along the way.
Setting up Data Services with PortalHQ webhooks allows us to receive events as they happen in Canvas and eliminates the need to poll Canvas API nightly.
Step 1: Log in as Admin and go to Data Services in the left side menu then click Add button
In case you can't see Data Services menu item, you will need to follow this article: How do I install Canvas Data Services using Live events in my account?
Step 2: Fill in the webhook details as per below
We're going to create 3 separate webhooks for:
- Assignments
- Submissions
- Comments
Give your webhooks a descriptive name so that you know which one is which easily. Something like PortalHQ Assignments Webhook, PortalHQ Submissions Webhook and PortalHQ Commnets Webhook will do.
Delivery Method: This must be set to HTTPS
Message Type: You must set this to Canvas
Application Type: This should be Data Streaming
URL: There are 3 different URLs you need to use:
- https://your_portalhq_url/canvas/webhooks/assignments/
- https://your_portalhq_url/canvas/webhooks/assignments/submissions/
- https://your_portalhq_url/canvas/webhooks/assignments/submissions/comments/
Finally, you need to select Assignments for your assignments webhook, Submissions for the submissions and Comments for the comments. Your Assignments webhook should look like this:
Here's an example of the Submissions webhook:
Simply repeat the process for the comments webhook. And finally, make sure you hit save in the top right.
Your Data Services list page should now have 3 data services webhooks in it.
If you want to learn more about Data Services in Canvas please go to this Instructure documents page.