Offering CompletedBeta

Last modified on September 11, 2023 at 6:05 pm

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

PropertyJSON Data TypeDescription
eventstringThis 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 segement them within your application.
datestringThe date and time when this event occurred. For more information on the format, see the Date/Time Format documentation.
sourcestringThe 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.
userobjectThe user that was registered for the offering that was completed.
user.idobjectThe id of the user. This uniquely identifies the user and can be used to query our API for more information about the user.
user.firstNamestringThe first name of the user.
user.lastNamestringThe last name of the user.
user.emailstringThe email address of the user.
user.usernamestringThis 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.localestringThis is the locale preference set on the user’s account
registrationobjectThe registration object holds information that is unique to this user and offering.
registration.idstringThe ID of this registration. This uniquely identifies the registration and can be used to query our API for more information about the registration.
registration.beginDatestringThe 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.endDatestringThe date and time when the user finished the offering. For more information on the format, see the Date/Time Format documentation.
registration.gradenumberThe grade that the user received.
registration.passedbooleanAn indication of whether or not the user received a passing grade for the offering.
offeringobjectThe offering that was completed.
offering.idstringThe ID of the offering. This uniquely identifies the offering and can be used to query our API for more information about the offering.
offering.titlestringThe title of the offering