Community

cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
SeanJago
New Member

Getting Notified When Someone Registers on Canvas

Jump to solution

Hi!

I am looking for either a webhook (ideally) or an API endpoint that I can poll in order to get details on new registrants/sign ups to Canvas...

I have looked through the API documentation but I can't seem to find anything but I am sure I am missing it or it is buried somewhere!

Thanks!

Labels (2)
0 Kudos
1 Solution

Accepted Solutions
James
Community Champion

@SeanJago 

Did you check out Live Events from Canvas Data Services? You can configure it to send a notification to an Amazon Web Services SQS Queue or a custom url (I had tested it with a server at our site before switching to Amazon).

I'm not sure exactly what you're looking for, but it can send a live event notification when an enrollment is created or a user is added. There are a lot of other things as well. Scroll down the Canvas LMS API documentation and you'll see Live Events at the bottom of the side menu.

That will let you know that something happened, but probably won't give you all of the details that you want. For that, you'll need to make a regular API call.

Live Events are not guaranteed. If there is network congestion or Canvas is experiencing a high load, you may not get a notification. Notifications are also sent only once. All that means you will need some other way of detecting things as a fallback.

I download information about each class on a nightly basis and cache it in a local database. Then I can process it to see what actions need performed that slipped through the cracks.

View solution in original post

2 Replies
James
Community Champion

@SeanJago 

Did you check out Live Events from Canvas Data Services? You can configure it to send a notification to an Amazon Web Services SQS Queue or a custom url (I had tested it with a server at our site before switching to Amazon).

I'm not sure exactly what you're looking for, but it can send a live event notification when an enrollment is created or a user is added. There are a lot of other things as well. Scroll down the Canvas LMS API documentation and you'll see Live Events at the bottom of the side menu.

That will let you know that something happened, but probably won't give you all of the details that you want. For that, you'll need to make a regular API call.

Live Events are not guaranteed. If there is network congestion or Canvas is experiencing a high load, you may not get a notification. Notifications are also sent only once. All that means you will need some other way of detecting things as a fallback.

I download information about each class on a nightly basis and cache it in a local database. Then I can process it to see what actions need performed that slipped through the cracks.

Thanks James!

This is my first time looking at Canvas and the scenario is that a customer of ours is looking to build a connection between their Canvas instance and their Influitive instance so I am just seeing what is possible.

The 'Live Event' section and specifically the 'user_created' event is exactly what I am looking for but I will take into account what you said about the unreliability of this method.

I will then grab the user ID and query to find the email using the /api/v1/users/:id endpoint.

Thanks for the direction, James!