Offering Registered

Last modified on June 5, 2024 at 1:30 pm

Offering Registered Event Webhook Example

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

  "event" : "offering_registered",
  "date" : "2014-04-18T00:43:07Z",
  "source" : "SELF",
  "user" : {
    "id" : "a0fbd5acd2214401a132221bd61fd412",
    "firstName" : "Vilhelmina",
    "lastName" : "Tocco",
    "username" : "",
    "email" : "",
    "locale" : "en"
  "registration" : {
    "id" : "69bb175e4fee404e83bb8615dd4a2df9"
  "offering" : {
    "id" : "63d626ac771c4be59440264c0ef4fdc3",
    "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 as registered. If students register for their own courses the source will be set to SELF. In the case that the instructor manually registers the student through the gradebook or some other means, the source will appear as ADMIN.
userobjectThe user that was registered for the offering.
user.idstringThe 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.
offeringobjectThe offering into which the user was registered.
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.