Offering Completed

Offering Completed Event Webhook Example

The following is an example of a JSON representation of an Offering Completed event. This illustrates how this event will be represented in the callback to your server.

{
  "event" : "offering_completed",
  "date" : "2014-04-18T00:39:57Z",
  "source" : "SELF",
  "user" : {
    "id" : "8920ae04b9d6461ea2c7de6f6240ec4f",
    "firstName" : "Biondello",
    "lastName" : "Brissette",
    "username" : "biobr@infoseller.com",
    "email" : "biobr@infoseller.com",
    "locale" : "en"
  },
  "registration" : {
    "id" : "0e110b8a72294161a589ade444bd978f",
    "beginDate" : "2013-09-19T00:39:57Z",
    "endDate" : "2014-11-15T00:39:57Z",
    "grade" : 58.0,
    "passed" : false
  },
  "offering" : {
    "id" : "c07fba9bfea94358b3fdd906b7d601a4",
    "title" : "Sample Course"
  }
}

Property Details

Property	JSON Data Type	Description
event	string	This is the event type that is being sent to this callback. If you are using the same callback URL for all events, you can use this to segment them within your application.
date	string	The date and time when this event occurred. For more information on the format, see the Date/Time Format documentation.
source	string	The source indicates how this offering was triggered to be completed. In most cases, students complete their own courses and the source will be set to SELF. In the case that the instructor manually completes the student through the gradebook, the source will appear as ADMIN.
user	object	The user that was registered for the offering that was completed.
user.id	string	The id of the user. This uniquely identifies the user and can be used to query our API for more information about the user.
user.firstName	string	The first name of the user.
user.lastName	string	The last name of the user.
user.email	string	The email address of the user.
user.username	string	This is the username for this user. If an organization uses username instead of email for login, this can be different than the email address.
user.locale	string	This is the locale preference set on the user’s account.
registration	object	The registration object holds information that is unique to this user and offering.
registration.id	string	The ID of this registration. This uniquely identifies the registration and can be used to query our API for more information about the registration.
registration.beginDate	string	The date and time when the user was first active in taking the offering. For more information on the format, see the Date/Time Format documentation.
registration.endDate	string	The date and time when the user finished the offering. For more information on the format, see the Date/Time Format documentation.
registration.grade	number	The grade that the user received.
registration.passed	boolean	An indication of whether or not the user received a passing grade for the offering.
offering	object	The offering that was completed.
offering.id	string	The ID of the offering. This uniquely identifies the offering and can be used to query our API for more information about the offering.
offering.title	string	The title of the offering.