Reporting Webhook Documentation

Our reporting webhook allows you to send your Lessonly training data to any service that can hold it. Below is the information we will need from you and what we will provide.

What will we need from the client
  • A Callback URL (for their web service endpoint).
  • Optional Value to be passed in the Authorization header. The Authorization header value will be passed exactly as written in this field. If this is field is blank, we will assume the Authorization header can be left out.
What information we provide

In JSON format, we will POST the following data to the Callback URL. You can store as much or as little of this information as you would like.

  • user
  • ext_uid (if your company is using it)
  • id
  • name
  • email address
  • any custom field info
  • lesson
  • lesson id
  • lesson title
  • retake_score (as an integer between 0 and 100)
  • score (as a decimal between 0 and 1.00) deprecated
  • score_percent (as a decimal between 0 and 100)
  • started date
  • completed date
  • assigned date
  • report card url

When a lesson is completed, we will POST this data to the callback url. If the POST fails, it will retry again up to 3 times every 5 minutes. If it fails after three attempts, it will stop attempting to POST. If you have any questions, email support@lessonly.com and we will be happy to help you out!

Sample Webhook Payload
{
  "user": {
    "ext_uid": "1234567890",
    "id": "1",
    "name": "Sample Sampleson",
    "email": "sample@company.co",
    "custom_fields": {
      "Custom Field Name": "Custom Field Value"
    }
  },
  "lesson": {
    "id": "1000",
    "title": "A Sample Lesson",
    "retake_score": 85
  },
  "score": 1,
  "score_percent": 100.0,
  "started_at": "2015-04-28T14:36:22Z",
  "completed_at": "2015-04-28T14:36:24Z",
  "assigned_at": "2015-04-28T14:36:18Z",
  "report_card_url": "http://sample.lessonly.com/assignments/100"
}
Sample CURL Command
curl -H "Authorization: YOUR_CUSTOM_AUTH_HEADER" -d '{"user":{"ext_uid":"1234567890","id":"1","name":"Sample Sampleson","email":"sample@company.co","custom_fields":{"Custom Field":"Custom Field Value"}},"lesson":{"id":"1000","title":"A Sample Lesson", "retake_score":85},"score":1,"score_percent":100,"started_at":"2015-04-28T14:36:22Z","completed_at":"2015-04-28T14:36:24Z","assigned_at":"2015-04-28T14:36:18Z","report_card_url":"http://sample.lessonly.com/assignments/100"}' YOUR_ENDPOINT_URL