When your webhook is sent successfully, it will deliver a payload to the Target URL. Check out common webhook payload samples containing example data from various Thinkific webhooks.
ATTENTION: This article is no longer up to date, and should be automatically redirecting you to a more current article in our Developer-specific documentation. If for some reason you are not redirected, please use this link to see the most recent version of this article.
In this article:
order.created Payload
{
"id": "20180126172320940835610",
"resource": "order",
"action": "created",
"tenant_id": "3",
"created_at": "2018-01-26T22:23:20.808Z",
"payload": {
"affiliate_referral_code": null,
"amount_cents": 5000,
"amount_dollars": 50,
"billing_name": "Robert Smith",
"coupon": null,
"created_at": "2018-01-26T22:23:18.400Z",
"id": 19796,
"order_number": 1010,
"payment_type": "one-time",
"product_id": 1,
"product_name": "Introduction to Webhooks",
"status": "Complete",
"user": {
"email": "ninjas@thinkific.com",
"first_name": "Robert",
"id": 123456,
"last_name": "Smith"
}
}
}
user.signin Payload
{
"id": "20180123154501518395902",
"resource": "user",
"action": "signin",
"tenant_id": "73394",
"created_at": "2018-01-23T20:45:00.314Z",
"payload": {
"administered_course_ids": null,
"affiliate_code": "e7c7eb",
"affiliate_commission": "15.00",
"affiliate_commission_type": "%",
"affiliate_payout_email": "user@thinkific.com",
"avatar_url": "https://s3.amazonaws.com/thinkific/profiles/002/121/9021516740299.thumb.?1516740299",
"bio": null,
"company": "",
"created_at": "2017-07-23T02:42:13.043Z",
"custom_profile_fields": [],
"email": "ninjas@thinkific.com",
"external_source": null,
"first_name": "Robert",
"headline": "Software Engineer",
"id": 123456,
"last_name": "Smith",
"roles": [
"affiliate"
]
}
}
user.signup Payload
{
"id": "20180123170248040678392",
"resource": "user",
"action": "signup",
"tenant_id": "73394",
"created_at": "2018-01-23T22:02:45.001Z",
"payload": {
"administered_course_ids": null,
"affiliate_code": null,
"affiliate_commission": null,
"affiliate_commission_type": "%",
"affiliate_payout_email": null,
"avatar_url": null,
"bio": null,
"company": null,
"created_at": "2018-01-23T22:02:44.987Z",
"custom_profile_fields": [],
"email": "ninjas@thinkific.com",
"external_source": null,
"first_name": "Robert",
"headline": null,
"id": 123456,
"last_name": "Smith",
"roles": []
}
}
enrollment.created Payload
{
"id": "20180126171756020665195",
"resource": "enrollment",
"action": "created",
"tenant_id": "3",
"created_at": "2018-01-26T22:17:01.924Z",
"payload": {
"activated_at": "2018-01-26T22:16:52.255Z",
"completed_at": null,
"course": {
"id": 4,
"name": "Introduction to Webhooks"
},
"course_id": 4,
"created_at": "2018-01-26T22:16:52.285Z",
"expiry_date": null,
"free_trial": false,
"id": 97472,
"percentage_completed": "0.0",
"started_at": "2018-01-26T22:17:01.891Z",
"updated_at": "2018-01-26T22:17:01.924Z",
"user": {
"email": "ninjas@thinkific.com",
"first_name": "Robert",
"id": 123456,
"last_name": "Smith"
}
}
}
enrollment.trial Payload
{
"id": "20180116184610563698247",
"resource": "enrollment",
"action": "trial",
"tenant_id": "1008",
"created_at": "2018-01-16T23:45:06.466Z",
"payload": {
"activated_at": null,
"completed_at": null,
"course": {
"id": 2692,
"name": "Introduction to Webhooks"
},
"course_id": 2692,
"created_at": "2018-01-16T23:45:03.227Z",
"expiry_date": null,
"free_trial": true,
"id": 97197,
"percentage_completed": "0.0",
"started_at": "2018-01-16T23:45:06.436Z",
"updated_at": "2018-01-16T23:45:06.466Z",
"user": {
"email": "ninjas@thinkific.com",
"first_name": "Robert",
"id": 123456,
"last_name": "Smith"
}
}
}
enrollment.completed Payload
{
"id": "20180126171947527620204",
"resource": "enrollment",
"action": "completed",
"tenant_id": "3",
"tenant_global_id": "09b66093-fc51-409d-af42-4c40d5a0f529",
"created_at": "2018-01-26T22:19:47.432Z",
"payload": {
"activated_at": "2018-01-26T22:19:26.972Z",
"completed_at": "2018-01-26T22:19:47.308Z",
"course": {
"id": 3891,
"name": "Introduction to Webhooks"
},
"course_id": 3891,
"created_at": "2018-01-26T22:19:26.995Z",
"expiry_date": null,
"free_trial": false,
"id": 97473,
"percentage_completed": "1.0",
"started_at": "2018-01-26T22:19:29.025Z",
"updated_at": "2018-01-26T22:19:47.432Z",
"user": {
"email": "ninjas@thinkific.com",
"first_name": "Robert",
"id": 123456,
"last_name": "Smith"
}
}
}
enrollment.progress Payload
{
"id": "20180118171806111886309",
"resource": "enrollment",
"action": "progress",
"tenant_id": "987",
"created_at": "2018-01-18T22:18:05.984Z",
"payload": {
"activated_at": "2018-01-18T22:17:52.380Z",
"completed_at": null,
"course": {
"id": 3035,
"name": "Introduction to Webhooks"
},
"course_id": 3035,
"created_at": "2018-01-18T22:17:52.459Z",
"expiry_date": null,
"free_trial": false,
"id": 97254,
"last_percentage_completed": "0.0",
"percentage_completed": "0.333333333333333",
"started_at": "2018-01-18T22:17:58.569Z",
"updated_at": "2018-01-18T22:18:05.984Z",
"user": {
"email": "ninjas@thinkific.com",
"first_name": "Robert",
"id": 123456,
"last_name": "Smith"
}
}
}
lesson.completed Payload
{
"id": "20191029145629636106318",
"resource": "lesson",
"action": "completed",
"tenant_id": "12345",
"tenant_global_id": "feb8d00d-8040-4382-afee-491a6c8013af",
"created_at": "2019-10-29T18:56:29.474Z",
"payload": {
"chapter": {
"id": 123,
"name": "Chapter 1"
},
"course": {
"id": 123,
"name": "Introduction to Webhooks"
},
"enrollment": {
"id": 1084282
},
"lesson": {
"id": 24220,
"name": "Getting started with Webhooks",
"position": 0,
"type": "Video"
},
"user": {
"email": "ninjas@thinkific.com",
"first_name": "Robert",
"id": 123456,
"last_name": "Smith"
}
}
}