Webhook events and data
On Teachable, the following webhook events are available:
| Webhook name | Event title | Description |
|---|---|---|
| New admission | Admission.created | A user is admitted, or enrolled, to a coaching service. |
| Admission disabled | Admission.disabled | A user is unenrolled from a coaching service. |
| New comment | Comment.created | A user leaves a comment on a course. |
| Email lead subscribed | EmailLead.created | A user has confirmed their subscription to your email list via an Email Leads Form. |
| Enrollment completed | Enrollment.completed | A user completes 100% of a course. |
| New enrollment | Enrollment.created | A user enrolls in a course (whether they purchased it or you manually added them). This differs from the New Sale trigger in that for bundled courses, each course in the bundled content will count as a separate enrollment event. |
| New unenrollment | Enrollment.disabled | A user is unenrolled from a course (includes manual unenrollment, unenrollment due to failed payments, or unenrollment when course access duration expires). |
| Lecture completed | LectureProgress.created | A user completes a lecture. |
| New quiz response | Response.created | A user completes a graded quiz. |
| New sale | Sale.created | A user enrolls in a product on your school or is manually enrolled. This trigger affects free and paid products. Bundles count as one sale event. |
| Subscription canceled | Sale.subscription_canceled | A student cancels a subscription on your school. |
| New transaction | Transaction.created | A user is charged and makes a payment for a product (could be a one-time purchase or an ongoing subscription/payment plan). For example, on a monthly subscription plan, there will be a new transaction event each month when the user is charged. This event does not include free products or products purchased with 100%-off coupons. |
| Transaction refunded | Transaction.refunded | A transaction is refunded. |
| New user | User.created | A user signs up/creates an account for your school. |
| User opts in to marketing emails | User.subscribe_to_marketing_emails | A user opts in to marketing emails. |
| User opts out of marketing emails | User.unsubscribe_from_marketing_emails | A user opts out of marketing emails. |
| User profile updated | User.updated | A user updates their profile on your school. |
| Tag added to user | UserTag.created | A tag is added to a user in your school. |
| Tag removed from user | UserTag.removed | A tag is removed from a user in your school. |
| Abandoned Cart | AbandonedOrder.created | A user did not complete the order in checkout. |
[
{
"type": "Admission.created",
"id": 12345,
"livemode": true,
"created": "2022-05-26T18:44:32+00:00",
"hook_event_id": 12345678,
"object": {
"user": {
"id": 1234567,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 123456,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": null,
"sign_in_count": 1,
"unsubscribe_from_marketing_emails": true
},
"purchasable": {
"type": "creator_product",
"creator_product": {
"id": 12345,
"author_bio_id": 1234567,
"description": "description text here",
"image_url": "https://cdn.filestackcontent.com/ABC123",
"name": "1-1 Ice Cream Making Session",
"position": 0,
"status": "unpublished",
"school_id": 123456,
"created_at": "2021-06-16T19:58:00Z",
"updated_at": "2021-06-16T20:01:38Z",
"friendly_url": "1-1-ice-cream-making-session1",
"destroyed_at": null,
"preferences": {
"button_text": "button text here"
},
"external_url": "",
"paypal_product_catalog_id": null
}
}
}
}
]
[
{
"type": "Admission.disabled",
"id": 123,
"livemode": true,
"created": "2022-05-26T18:50:35+00:00",
"hook_event_id": 4512345678,
"object": {
"user": {
"id": 1234567,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 123456,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": "2022-05-26T18:44:31Z",
"sign_in_count": 2,
"unsubscribe_from_marketing_emails": true
},
"purchasable": {
"type": "creator_product",
"creator_product": {
"id": 12345,
"author_bio_id": 12334567,
"description": "description text here",
"image_url": "https://cdn.filestackcontent.com/ABC123",
"name": "1-1 Ice Cream Making Session",
"position": 0,
"status": "unpublished",
"school_id": 123456,
"created_at": "2021-06-16T19:58:00Z",
"updated_at": "2021-06-16T20:01:38Z",
"friendly_url": "1-1-ice-cream-making-session1",
"destroyed_at": null,
"preferences": {
"button_text": "button text here"
},
"external_url": "",
"paypal_product_catalog_id": null
}
}
}
}
]
[
{
"type":"Comment.created",
"id":214950,
"livemode":true,
"created":"2017-05-15T18:53:43+00:00",
"hook_event_id":1,
"object":{
"id":214950,
"user_id":3119253,
"school_id":69842,
"created_at":"2017-01-19T17:39:02Z",
"updated_at":"2017-01-19T17:39:02Z",
"body": "comment text here",
"user":{
"id":3119253,
"role":"student",
"email":"[email protected]",
"name":"John Doe",
"school_id":69842,
"src":null,
"first_touch":null,
"last_touch":null,
"last_sign_in_at":"2017-01-19T17:38:48Z",
"sign_in_count":11,
"unsubscribe_from_marketing_emails":null
},
"commentable":{
"created_at":"2017-01-19T17:30:13Z",
"code_syntax":null,
"content_type":null,
"audio_type":null,
"should_be_uploaded_to_wistia?":false,
"data":null,
"schema":null,
"text_constructor":null,
"full_url": "https://schoolurl.teachable.com/courses/111111/lectures/1234567",
"cdn_url":null,
"url":null,
"host_id":null,
"source":"user",
"kind":"native_comments",
"name":null,
"host":null,
"position":1,
"attachable_id":2034508,
"is_published":true,
"downloadable":false,
"text":null,
"attachable_type":"Lecture",
"thumbnail_url":null,
"meta":{
"class":"attachment",
"url":null,
"name":null,
"description":null,
"image_url":null,
"status":null
},
"embeddable":true,
"id":45307557,
"display_text":"",
"plain_text_html":""
}
}
}
]
[
{
"type": "EmailLead.created",
"id": 123456,
"livemode": true,
"created": "2022-05-26T19:46:41+00:00",
"hook_event_id": 12345678,
"object": {
"email": "[email protected]",
"source": "Form name here",
"created_at": "2022-05-26T19:46:41Z"
}
}
]
[
{
"type": "Enrollment.completed",
"id": 1234567,
"livemode": true,
"created": "2022-05-27T14:47:25+00:00",
"hook_event_id": 12345678,
"object": {
"created_at": "2022-05-27T14:46:57Z",
"shipping_address": null,
"coupon": null,
"user_id": 1234567,
"course_id": 123456,
"primary_course_id": 123456,
"sale_id": 1234567,
"is_active": true,
"enrolled_at": "2022-05-27T14:46:57Z",
"percent_complete": 0,
"has_full_access": false,
"id": 1234567,
"course_progress_id": 12345678,
"updated_at": "2022-05-27T14:46:57Z",
"meta": {
"class": "enrollment",
"url": null,
"name": "1234567",
"description": "",
"image_url": null,
"status": null
},
"user": {
"created_at": "2022-05-27T14:46:56Z",
"current_sign_in_at": "2022-05-27T14:46:56Z",
"sign_in_count": 1,
"role": "student",
"sanitized_name": "John Doe",
"gravatar_url": "https://s.gravatar.com/avatar/abc123",
"is_teachable_account": false,
"author_bio_id": null,
"custom_role_name": null,
"primary_owner?": false,
"show_custom_role_upgrade?": false,
"has_zoom_credential?": false,
"referral_program_code": null,
"email": "[email protected]",
"notes": null,
"affiliate_code": "1234_a12bc_it",
"name": "John Doe",
"is_owner": false,
"is_student": true,
"is_affiliate": false,
"is_author": false,
"src": null,
"confirmed_at": null,
"last_four": null,
"paypal_email": null,
"affiliate_revenue_share": null,
"joined_at": "2022-05-27T14:46:56Z",
"signed_up_affiliate_code": null,
"author_revenue_share": 0,
"last_sign_in_ip": null,
"current_sign_in_ip": "12.12.12.123",
"id": 73647851,
"school_id": 12345,
"teachable_account_id": null,
"is_staff_user": null,
"agree_updated_privacy_policy": true,
"unsubscribe_from_marketing_emails": true,
"meta": {
"class": "user",
"url": null,
"name": "John Doe",
"description": "",
"image_url": null,
"status": null
},
"transactions_gross": 0,
"shipping_address": null,
"business_name": null,
"is_google_account": false,
"custom_role": null,
"author_bio": null,
"tags": []
},
"course": {
"id": 123456,
"name": "Cake Pops 101",
"url": "https://the-sweet-shop.teachable.com/courses/1234",
"friendly_url": "cake-pops-1011",
"meta_description": "description here",
"description": null,
"author_bio": {
"created_at": "2021-06-15T17:20:55Z",
"profile_image_url": "https://www.filepicker.io/api/file/abc123",
"bio": "bio description here",
"position": null,
"user_id": null,
"name": "Jane Doe",
"id": 123456,
"meta": {
"class": "authorbio",
"url": "/author_bios/123456",
"name": "Jane Doe",
"description": "",
"image_url": null,
"status": null
},
"user_name": "",
"user_is_owner": null,
"user_has_custom_role": null
}
},
"certificate_serial_number": null
}
}
]
[
{
"type": "Enrollment.created",
"id": 123456,
"livemode": true,
"created": "2022-05-27T14:47:05+00:00",
"hook_event_id": 12345678,
"object": {
"created_at": "2022-05-27T14:46:57Z",
"shipping_address": null,
"coupon": null,
"user_id": 123456,
"course_id": 123456,
"primary_course_id": 123456,
"sale_id": 1234567,
"is_active": true,
"enrolled_at": "2022-05-27T14:46:57Z",
"percent_complete": 0,
"has_full_access": false,
"id": 12345678,
"course_progress_id": 1234567,
"updated_at": "2022-05-27T14:46:57Z",
"meta": {
"class": "enrollment",
"url": null,
"name": "791062947",
"description": "",
"image_url": null,
"status": null
},
"user": {
"created_at": "2022-05-27T14:46:56Z",
"current_sign_in_at": "2022-05-27T14:46:56Z",
"sign_in_count": 1,
"role": "student",
"sanitized_name": "John Doe",
"gravatar_url": "https://s.gravatar.com/avatar/abc123",
"is_teachable_account": false,
"author_bio_id": null,
"custom_role_name": null,
"primary_owner?": false,
"show_custom_role_upgrade?": false,
"has_zoom_credential?": false,
"referral_program_code": null,
"email": "[email protected]",
"notes": null,
"affiliate_code": "1234_abc_it",
"name": "tori enrollmentcompleted",
"is_owner": false,
"is_student": true,
"is_affiliate": false,
"is_author": false,
"src": null,
"confirmed_at": null,
"last_four": null,
"paypal_email": null,
"affiliate_revenue_share": null,
"joined_at": "2022-05-27T14:46:56Z",
"signed_up_affiliate_code": null,
"author_revenue_share": 0,
"last_sign_in_ip": null,
"current_sign_in_ip": "12.12.12.123",
"id": 123456,
"school_id": 123456,
"teachable_account_id": null,
"is_staff_user": null,
"agree_updated_privacy_policy": true,
"unsubscribe_from_marketing_emails": true,
"meta": {
"class": "user",
"url": null,
"name": "John Doe",
"description": "",
"image_url": null,
"status": null
},
"transactions_gross": 0,
"shipping_address": null,
"business_name": null,
"is_google_account": false,
"custom_role": null,
"author_bio": null,
"tags": []
},
"course": {
"id": 123456,
"name": "Cake Pops 101",
"url": "https://the-sweet-shop.teachable.com/courses/12345",
"friendly_url": "cake-pops-1011",
"meta_description": "description here",
"description": null,
"author_bio": {
"created_at": "2021-06-15T17:20:55Z",
"profile_image_url": "https://www.filepicker.io/api/file/abc123",
"bio": "bio here",
"position": null,
"user_id": null,
"name": "Jane Doe",
"id": 123456,
"meta": {
"class": "authorbio",
"url": "/author_bios/123456",
"name": "Jane Doe",
"description": "",
"image_url": null,
"status": null
},
"user_name": "",
"user_is_owner": null,
"user_has_custom_role": null
}
}
}
}
]
[
{
"type": "Enrollment.disabled",
"id": 123456,
"livemode": true,
"created": "2022-05-27T15:19:49+00:00",
"hook_event_id": 12345678,
"object": {
"created_at": "2022-05-27T14:46:57Z",
"shipping_address": null,
"coupon": null,
"user_id": 1234567,
"course_id": 123456,
"primary_course_id": 123456,
"sale_id": 123456789,
"is_active": false,
"enrolled_at": "2022-05-27T14:46:57Z",
"percent_complete": 0,
"has_full_access": false,
"id": 1234567,
"course_progress_id": 1234567,
"updated_at": "2022-05-27T15:19:35Z",
"meta": {
"class": "enrollment",
"url": null,
"name": "1234567",
"description": "",
"image_url": null,
"status": null
},
"user": {
"created_at": "2022-05-27T14:46:56Z",
"current_sign_in_at": "2022-05-27T14:46:58Z",
"sign_in_count": 2,
"role": "student",
"sanitized_name": "John Doe",
"gravatar_url": "https://s.gravatar.com/avatar/abc123",
"is_teachable_account": false,
"author_bio_id": null,
"custom_role_name": null,
"primary_owner?": false,
"show_custom_role_upgrade?": false,
"has_zoom_credential?": false,
"referral_program_code": null,
"email": "[email protected]",
"notes": null,
"affiliate_code": "12344_abc_it",
"name": "John Doe",
"is_owner": false,
"is_student": true,
"is_affiliate": false,
"is_author": false,
"src": null,
"confirmed_at": null,
"last_four": null,
"paypal_email": null,
"affiliate_revenue_share": null,
"joined_at": "2022-05-27T14:46:56Z",
"signed_up_affiliate_code": null,
"author_revenue_share": 0,
"last_sign_in_ip": "12.12.12.123",
"current_sign_in_ip": "12.12.12.123",
"id": 1234567,
"school_id": 123456,
"teachable_account_id": null,
"is_staff_user": null,
"agree_updated_privacy_policy": true,
"unsubscribe_from_marketing_emails": true,
"meta": {
"class": "user",
"url": null,
"name": "John Doe",
"description": "",
"image_url": null,
"status": null
},
"transactions_gross": 0,
"shipping_address": null,
"business_name": null,
"is_google_account": false,
"custom_role": null,
"author_bio": null,
"tags": []
},
"course": {
"id": 1440384,
"name": "Cake Pops 101",
"url": "https://the-sweet-shop.teachable.com/courses/1234",
"friendly_url": "cake-pops-1011",
"meta_description": "description here",
"description": null,
"author_bio": {
"created_at": "2021-06-15T17:20:55Z",
"profile_image_url": "https://www.filepicker.io/api/file/abc123",
"bio": "bio here",
"position": null,
"user_id": null,
"name": "Jane Doe",
"id": 123456,
"meta": {
"class": "authorbio",
"url": "/author_bios/123456",
"name": "Jane Doe",
"description": "",
"image_url": null,
"status": null
},
"user_name": "",
"user_is_owner": null,
"user_has_custom_role": null
}
}
}
}
]
[
{
"type": "LectureProgress.created",
"id": 12345678,
"livemode": true,
"created": "2022-05-27T14:47:25+00:00",
"hook_event_id": 123456789,
"object": {
"id": 12345678,
"is_completed": true,
"course_id": 123456,
"lecture_id": 1234567,
"school_id": 123456,
"percent_complete": 50,
"course": {
"id": 1234567,
"name": "Cake Pops 101",
"url": "https://the-sweet-shop.teachable.com/courses/1234",
"friendly_url": "cake-pops-1011",
"meta_description": "description here",
"description": null,
"author_bio": {
"created_at": "2021-06-15T17:20:55Z",
"profile_image_url": "https://www.filepicker.io/api/file/abc123",
"bio": "bio here",
"position": null,
"user_id": null,
"name": "Jane Doe",
"id": 1112734,
"meta": {
"class": "authorbio",
"url": "/author_bios/1234",
"name": "Jane Doe",
"description": "",
"image_url": null,
"status": null
},
"user_name": "",
"user_is_owner": null,
"user_has_custom_role": null
}
},
"user": {
"id": 12345,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 12345,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": "2022-05-27T14:46:56Z",
"sign_in_count": 2,
"unsubscribe_from_marketing_emails": true
},
"lecture": {
"id": 1234567,
"name": "lecture name",
"is_published": true
}
}
}
]
[
{
"type": "Response.created",
"id": 123456,
"livemode": true,
"created": "2022-05-27T15:46:33+00:00",
"hook_event_id": 1234567,
"object": {
"id": 123456,
"user_id": 123456,
"custom_form_id": 123456,
"answers": {
"answer-1": [
"answer choice 1"
],
"answer-2": [
"answer choice 2"
]
},
"created_at": "2022-05-27T15:46:29Z",
"updated_at": "2022-05-27T15:46:32Z",
"school_id": 123456,
"submitted_at": "2022-05-27T15:46:32Z",
"grade": {
"total": 2,
"correct": 1,
"answered": 2,
"remaining": 0,
"percent_correct": 0.5,
"percent_answered": 1
},
"custom_form": {
"id": 12345,
"type": "Quiz",
"topic_id": 123456,
"topic_type": "Attachment",
"data": {
"graded": true,
"answerKey": {
"answer-1": [
"answer choice 1"
],
"answer-2": [
"answer choice 1"
]
}
},
"school_id": 123456,
"is_published": false,
"identifier": null,
"created_at": "2022-05-27T15:45:54Z",
"updated_at": "2022-05-27T15:46:15Z",
"schema": {
"type": "object",
"required": [
"answer-1",
"answer-2"
],
"properties": {
"answer-1": {
"enum": [
"answer choice 1",
"answer choice 2"
],
"type": "string",
"title": "question A",
"description": "single"
},
"answer-2": {
"enum": [
"answer choice 1",
"answer choice 2"
],
"type": "string",
"title": "question B",
"description": "single"
}
}
},
"attachment": {
"id": 123456,
"attachable_type": "Lecture",
"attachable_id": 123456,
"kind": "quiz"
}
},
"user": {
"id": 123455,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 12345,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": "2022-05-27T14:46:56Z",
"sign_in_count": 2,
"unsubscribe_from_marketing_emails": true
}
}
}
]
[
{
"type": "Sale.created",
"id": 1234567,
"livemode": true,
"created": "2022-05-27T15:45:20+00:00",
"hook_event_id": 12345678,
"object": {
"id": 123456788,
"price": 0,
"currency": "USD",
"is_active": true,
"is_recurring": false,
"user_id": 123456,
"school_id": 12345,
"final_price": 0,
"shipping_address": null,
"course": {
"id": 123456,
"name": "Cake Pops 101",
"url": "https://the-sweet-shop.teachable.com/courses/1234",
"friendly_url": "cake-pops-1011",
"meta_description": "description here",
"description": null,
"author_bio": {
"created_at": "2021-06-15T17:20:55Z",
"profile_image_url": "https://www.filepicker.io/api/file/abc123",
"bio": "bio here",
"position": null,
"user_id": null,
"name": "Jane Doe",
"id": 1112734,
"meta": {
"class": "authorbio",
"url": "/author_bios/1234",
"name": "Jane Doe",
"description": "",
"image_url": null,
"status": null
},
"user_name": "",
"user_is_owner": null,
"user_has_custom_role": null
}
},
"product": {
"id": 123456,
"is_recurring": false,
"price": 0,
"name": "Admin enrolled",
"currency": "USD"
},
"user": {
"id": 12345,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 12345,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": "2022-05-27T14:46:56Z",
"sign_in_count": 2,
"unsubscribe_from_marketing_emails": true
},
"coupon": {
"created_at": "2022-05-27T15:45:19Z",
"scope_name": "",
"pricing_plan_specific": true,
"is_for_student_referral": false,
"student_referral_type": null,
"new_purchase_price": 0,
"formatted_discount": "$0",
"formatted_price": "FREE",
"calculated_discount": 0,
"currency": "USD",
"discount_percent": 1,
"discount_amount": null,
"number_available": 0,
"code": "ABC123",
"name": "Admin enrollment by [email protected] - 1234567",
"expiration_date": "2024-05-27T15:45:19+00:00",
"product_id": 12345,
"is_published": true,
"duration_kind": "once",
"number_of_uses": 1,
"class_period_id": null,
"id": 229631482,
"meta": {
"class": "coupon",
"url": null,
"name": "Admin enrollment by [email protected] - 1234567",
"description": "",
"image_url": null,
"status": null
},
"product": {
"created_at": "2022-05-03T14:19:22Z",
"formatted_price": "FREE",
"formatted_period_full_words": "monthly",
"formatted_price_no_period": "FREE",
"course_id": 12345,
"name": "Admin enrolled",
"description": null,
"billing_interval": "month",
"enrollment_cap": null,
"enrollment_cap_fulfillment_count": 0,
"enrollment_cap_visible": false,
"detailed_description": null,
"currency": "USD",
"position": 5,
"price": 0,
"is_recurring": false,
"is_published": false,
"billing_interval_count": 1,
"author_revenue_share": null,
"num_payments_required": null,
"free_trial_length": null,
"id": 12345,
"access_limit_duration": null,
"access_limit_interval": null,
"access_limit_date": null,
"meta": {
"class": "product",
"url": null,
"name": "Admin enrolled",
"description": null,
"image_url": null,
"status": null
},
"course": {
"created_at": "2021-06-16T19:58:11Z",
"path": "/courses/12345",
"safe_image_url": "https://process.fs.teachablecdn.com/abc123",
"has_published_lecture": true,
"has_published_product": true,
"promo_video": null,
"name": "Cake Pops 101",
"template": "classic",
"heading": "heading text",
"page_title": "Cake Pops 101",
"meta_description": "description text",
"friendly_url": "cake-pops-1011",
"description": null,
"author_bio_id": 123456,
"position": 7,
"conversion_pixels": null,
"closing_letter": null,
"image_url": "https://www.filepicker.io/api/file/abc123",
"hero_image_url": null,
"is_published": true,
"bundled_courses_count": 0,
"child_course_ids": [],
"preenrollment_call_to_action": "copy here",
"is_open": true,
"is_accepting_preenrollments": false,
"use_old_course_page": null,
"skip_thank_you_page": null,
"onboarded_at": null,
"id": 123456,
"default_page_id": 123456,
"checkout_sidebar_page_id": 123456,
"certificate_page_id": null,
"purchase_redirect_url": null,
"mobile_thumbnail_url": "https://assets.teachablecdn.com/icons/example.png",
"mobile_hero_image_url": "https://assets.teachablecdn.com/bg/example.png",
"post_purchase_page_id": 123456,
"issue_certificates_manually": null,
"is_video_completion_enforced": false,
"is_lecture_order_enforced": false,
"is_minimum_quiz_score_enforced": false,
"minimum_quiz_score": 0,
"maximum_quiz_retakes": 0,
"is_maximum_content_width_enforced": null,
"meta": {
"class": "course",
"url": "/courses/12345/",
"name": "Cake Pops 101",
"description": null,
"image_url": "https://www.filepicker.io/api/file/abc123",
"status": null
},
"categories": [],
"author_bio": {
"created_at": "2021-06-15T17:20:55Z",
"profile_image_url": "https://www.filepicker.io/api/file/abc123",
"bio": "bio here",
"position": null,
"user_id": null,
"name": "Jane Doe",
"id": 12345,
"meta": {
"class": "authorbio",
"url": "/author_bios/12345",
"name": "Jane Doe",
"description": "",
"image_url": null,
"status": null
},
"user_name": "",
"user_is_owner": null,
"user_has_custom_role": null
}
},
"creator_product": null,
"product_collection": null
}
},
"affiliate": null,
"transactions": []
}
}
]
[
{
"type": "Sale.subscription_canceled",
"id": 12345,
"livemode": true,
"created": "2022-05-27T19:28:50+00:00",
"hook_event_id": 12345,
"object": {
"id": 12345,
"price": 200,
"currency": "USD",
"is_active": true,
"is_recurring": true,
"user_id": 12345,
"school_id": 12345,
"final_price": 200,
"shipping_address": {
"id": 12345,
"line1": "123 Main Street",
"line2": null,
"city": "Anytown",
"region": "CA",
"postal_code": "12345",
"country": "US",
"school_id": 12345,
"created_at": "2022-05-27T19:03:52Z",
"updated_at": "2022-05-27T19:03:52Z"
},
"course": {
"id": 1440378,
"name": "Whipped Cream 101",
"url": "https://the-sweet-shop.teachable.com/courses/1234",
"friendly_url": "friendly-url",
"meta_description": null,
"description": null,
"author_bio": {
"created_at": "2021-06-16T19:58:00Z",
"profile_image_url": null,
"bio": "",
"position": null,
"user_id": null,
"name": "author name",
"id": 12345,
"meta": {
"class": "authorbio",
"url": "/author_bios/12345",
"name": "author name",
"description": "",
"image_url": null,
"status": null
},
"user_name": "",
"user_is_owner": null,
"user_has_custom_role": null
}
},
"product": {
"id": 12345,
"is_recurring": true,
"price": 200,
"name": "2 per month",
"currency": "USD"
},
"user": {
"id": 12345,
"role": "student",
"email": "[email protected]",
"name": "tori newname",
"school_id": 12345,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": "2022-05-27T14:46:58Z",
"sign_in_count": 3,
"unsubscribe_from_marketing_emails": true
},
"coupon": null,
"affiliate": null,
"transactions": [
{
"created_at": "2022-05-27T19:04:00Z",
"custom_gateway?": false,
"fully_refunded?": true,
"is_stripe_connect?": false,
"is_custom_paypal?": false,
"is_teachable_payments?": false,
"charged_back_at": null,
"reserves": [],
"first_charge_on_sale?": true,
"has_fraud_warning?": false,
"purchased_item_name": "Whipped Cream 101",
"purchased_item_id": 12345,
"purchased_item_type": "Course",
"purchaser_business_name": null,
"order_bump": null,
"order_bump_formatted_offer_price": null,
"usable_fee_ratio": 1,
"upsell_offer_id": null,
"user_id": 12345,
"final_price": 200,
"currency": "USD",
"affiliate_percent": 0,
"author_percent": 0,
"author_id": null,
"teachable_percent": 0,
"teachable_processor_fee": 0,
"amount_refunded": 200,
"status": "paid",
"affiliate_fees": 0,
"author_fees": 0,
"sale_id": 12345,
"coupon_id": null,
"net_charge": 0,
"earnings_usd": 0,
"net_charge_usd": 0,
"teachable_fixed_fee": 0,
"total_teachable_fee": 0,
"teachable_gateway_fee": 0,
"is_recurring": true,
"stripe_charge_token": "ch_123",
"paypal_payment_id": null,
"paypal_subscription_id": null,
"stripe_invoice_id": null,
"purchased_at": "2022-05-27T19:03:59Z",
"refundable": false,
"vat_fees": 0,
"is_chargeback": null,
"id": 12345,
"net_tax_charge": 0,
"original_product_charge_usd": 200,
"net_product_charge_usd": 0,
"marketplace_affiliate_id": null,
"marketplace_affiliate_fees": 0,
"marketplace_teachable_fees": 0,
"teachable_generated_lead_fee_percent": null,
"chargeback_fee": null,
"back_office_fee_percent": "0.02",
"back_office_fee": 0,
"fee_details": {
"base": "30",
"rate": "0.029",
"cross_border": "false",
"payment_method": "stripe",
"cross_border_assessed": "true"
},
"school_receives_vat_fees": null,
"meta": {
"class": "transaction",
"url": null,
"name": "12345",
"description": "",
"image_url": null,
"status": "paid"
}
}
]
}
}
]
[
{
"type": "Transaction.created",
"id": 12345,
"livemode": true,
"created": "2022-05-27T19:04:47+00:00",
"hook_event_id": 12345,
"object": {
"id": 12345,
"user_id": 12345,
"school_id": 12345,
"final_price": 200,
"currency": "USD",
"affiliate_percent": 0,
"author_percent": 0,
"fedora_percent": 0,
"amount_refunded": 0,
"status": "paid",
"is_recurring": true,
"sale_id": 12345,
"coupon_id": null,
"net_charge": 200,
"stripe_charge_token": "ch_123",
"net_charge_usd": 200,
"fedora_fee": 0,
"net_revenue_usd": 161,
"processor_fee_description": null,
"affiliate_fees": 0,
"earnings_usd": 161,
"paypal_payment_id": null,
"legacy_id": null,
"purchased_at": "2022-05-27T19:03:59Z",
"author_fees": 0,
"stripe_invoice_id": null,
"stripe_event_id": null,
"refunder_id": null,
"processor_fee": 36,
"total_fedora_fee": 3,
"is_chargeback": null,
"is_stripe_connect": null,
"author_id": null,
"credential_id": null,
"is_custom_paypal": null,
"data": {
"id": "ch_123",
"paid": true,
"order": null,
"amount": 200,
"object": "charge",
"review": null,
"source": null,
"status": "succeeded",
"created": 12345,
"dispute": null,
"invoice": null,
"outcome": {
"type": "authorized",
"reason": null,
"risk_level": "normal",
"risk_score": 0,
"network_status": "approved_by_network",
"seller_message": "Payment complete."
},
"refunds": {
"url": "/v1/charges/ch_123/refunds",
"data": [],
"object": "list",
"has_more": false,
"total_count": 0
},
"captured": true,
"currency": "usd",
"customer": "cus_abc123",
"disputed": false,
"livemode": true,
"metadata": {
"name": "John Doe",
"email": "[email protected]",
"order": "order_abc",
"country": "US",
"school_id": "12345",
"product_id": "12345",
"course_name": "Course name here",
"product_name": "pricing plan name here"
},
"refunded": false,
"shipping": null,
"application": null,
"description": "description here",
"destination": null,
"receipt_url": "https://pay.stripe.com/receipts/acct_123anc/ch_123",
"failure_code": null,
"on_behalf_of": null,
"fraud_details": {},
"receipt_email": null,
"transfer_data": null,
"payment_intent": "pi_1a2b3c",
"payment_method": "pm_1a2b3c",
"receipt_number": null,
"transfer_group": null,
"amount_captured": 200,
"amount_refunded": 0,
"application_fee": null,
"billing_details": {
"name": "John Doe",
"email": "[email protected]",
"phone": null,
"address": {
"city": null,
"line1": null,
"line2": null,
"state": null,
"country": null,
"postal_code": "12345"
}
},
"failure_message": null,
"source_transfer": null,
"balance_transaction": {
"id": "txn_1a2b3c",
"fee": 0,
"net": 200,
"type": "charge",
"amount": 200,
"object": "balance_transaction",
"source": "ch_123",
"status": "pending",
"created": 12345,
"currency": "usd",
"description": "description here",
"fee_details": [],
"available_on": 12345,
"exchange_rate": null,
"reporting_category": "charge"
},
"statement_descriptor": "The Sweet Shop",
"application_fee_amount": null,
"payment_method_details": {
"card": {
"iin": null,
"brand": "visa",
"last4": "1234",
"checks": {
"cvc_check": "pass",
"address_line1_check": null,
"address_postal_code_check": "pass"
},
"issuer": "Card Issuer here",
"wallet": null,
"country": "US",
"funding": "debit",
"mandate": null,
"network": "visa",
"exp_year": 2025,
"exp_month": 2,
"description": "Visa Classic",
"fingerprint": "ABC123",
"installments": null,
"three_d_secure": null
},
"type": "card"
},
"failure_balance_transaction": null,
"statement_descriptor_suffix": null,
"calculated_statement_descriptor": "THE SWEET SHOP"
},
"vat_fees": 0,
"usd_conversion_rate": null,
"school_plan_id": 123,
"shipping_address": {
"id": 12345,
"line1": "123 Main Street",
"line2": null,
"city": "Anytown",
"region": "CA",
"postal_code": "12345",
"country": "US",
"school_id": 12345,
"created_at": "2022-05-27T19:03:52Z",
"updated_at": "2022-05-27T19:03:52Z"
},
"sale": {
"id": 12345,
"price": 200,
"currency": "USD",
"is_active": true,
"is_recurring": true,
"user_id": 12345,
"school_id": 12345,
"final_price": 200,
"shipping_address": {
"id": 12345,
"line1": "123 Main Street",
"line2": null,
"city": "Anytown",
"region": "CA",
"postal_code": "12345",
"country": "US",
"school_id": 12345,
"created_at": "2022-05-27T19:03:52Z",
"updated_at": "2022-05-27T19:03:52Z"
},
"course": {
"id": 12345,
"name": "Whipped Cream 101",
"url": "https://the-sweet-shop.teachable.com/courses/1234",
"friendly_url": "friendly-url-here",
"meta_description": null,
"description": null,
"author_bio": {
"created_at": "2021-06-16T19:58:00Z",
"profile_image_url": null,
"bio": "",
"position": null,
"user_id": null,
"name": "author name",
"id": 12345,
"meta": {
"class": "authorbio",
"url": "/author_bios/12345",
"name": "author name",
"description": "",
"image_url": null,
"status": null
},
"user_name": "",
"user_is_owner": null,
"user_has_custom_role": null
}
},
"product": {
"id": 12345,
"is_recurring": true,
"price": 200,
"name": "pricing plan name",
"currency": "USD"
},
"user": {
"id": 12345,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 12345,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": "2022-05-27T14:46:58Z",
"sign_in_count": 3,
"unsubscribe_from_marketing_emails": true
},
"coupon": null,
"affiliate": null,
"transactions": [
{
"created_at": "2022-05-27T19:04:00Z",
"custom_gateway?": false,
"fully_refunded?": false,
"is_stripe_connect?": false,
"is_custom_paypal?": false,
"is_teachable_payments?": false,
"charged_back_at": null,
"reserves": [],
"first_charge_on_sale?": true,
"has_fraud_warning?": false,
"purchased_item_name": "Whipped Cream 101",
"purchased_item_id": 1440378,
"purchased_item_type": "Course",
"purchaser_business_name": null,
"order_bump": null,
"order_bump_formatted_offer_price": null,
"usable_fee_ratio": 1,
"upsell_offer_id": null,
"user_id": 12345,
"final_price": 200,
"currency": "USD",
"affiliate_percent": 0,
"author_percent": 0,
"author_id": null,
"teachable_percent": 0,
"teachable_processor_fee": 36,
"amount_refunded": 0,
"status": "paid",
"affiliate_fees": 0,
"author_fees": 0,
"sale_id": 12345,
"coupon_id": null,
"net_charge": 200,
"earnings_usd": 161,
"net_charge_usd": 200,
"teachable_fixed_fee": 0,
"total_teachable_fee": 3,
"teachable_gateway_fee": 0,
"is_recurring": true,
"stripe_charge_token": "ch_123",
"paypal_payment_id": null,
"paypal_subscription_id": null,
"stripe_invoice_id": null,
"purchased_at": "2022-05-27T19:03:59Z",
"refundable": true,
"vat_fees": 0,
"is_chargeback": null,
"id": 12345,
"net_tax_charge": 0,
"original_product_charge_usd": 200,
"net_product_charge_usd": 200,
"marketplace_affiliate_id": null,
"marketplace_affiliate_fees": 0,
"marketplace_teachable_fees": 0,
"teachable_generated_lead_fee_percent": null,
"chargeback_fee": null,
"back_office_fee_percent": "0.02",
"back_office_fee": 3,
"fee_details": {
"base": "30",
"rate": "0.029",
"cross_border": "false",
"payment_method": "stripe",
"cross_border_assessed": "true"
},
"school_receives_vat_fees": null,
"meta": {
"class": "transaction",
"url": null,
"name": "12345",
"description": "",
"image_url": null,
"status": "paid"
}
}
]
},
"user": {
"id": 12345,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 12345,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": "2022-05-27T14:46:58Z",
"sign_in_count": 3,
"unsubscribe_from_marketing_emails": true
},
"coupon": null
}
}
]
[
{
"type": "Transaction.refunded",
"id": 12345,
"livemode": true,
"created": "2022-05-27T19:15:32+00:00",
"hook_event_id": 12345,
"object": {
"id": 12345,
"user_id": 12345,
"school_id": 12345,
"final_price": 200,
"currency": "USD",
"affiliate_percent": 0,
"author_percent": 0,
"fedora_percent": 0,
"amount_refunded": 200,
"status": "paid",
"is_recurring": true,
"sale_id": 12345,
"coupon_id": null,
"net_charge": 0,
"stripe_charge_token": "ch_123",
"net_charge_usd": 0,
"fedora_fee": 0,
"net_revenue_usd": 0,
"processor_fee_description": null,
"affiliate_fees": 0,
"earnings_usd": 0,
"paypal_payment_id": null,
"legacy_id": null,
"purchased_at": "2022-05-27T19:03:59Z",
"author_fees": 0,
"stripe_invoice_id": null,
"stripe_event_id": null,
"refunder_id": 12345,
"processor_fee": 0,
"total_fedora_fee": 0,
"is_chargeback": null,
"is_stripe_connect": null,
"author_id": null,
"credential_id": null,
"is_custom_paypal": null,
"data": {
"id": "ch_123",
"paid": true,
"order": null,
"amount": 200,
"object": "charge",
"review": null,
"source": null,
"status": "succeeded",
"created": 12345,
"dispute": null,
"invoice": null,
"outcome": {
"type": "authorized",
"reason": null,
"risk_level": "normal",
"risk_score": 0,
"network_status": "approved_by_network",
"seller_message": "Payment complete."
},
"refunds": {
"url": "/v1/charges/ch_123/refunds",
"data": [
{
"id": "re_123",
"amount": 200,
"charge": "ch_123",
"object": "refund",
"reason": null,
"status": "succeeded",
"created": 12345,
"currency": "usd",
"metadata": {},
"payment_intent": "pi_2123",
"receipt_number": null,
"transfer_reversal": null,
"balance_transaction": {
"id": "txn_123",
"fee": 0,
"net": -200,
"type": "refund",
"amount": -200,
"object": "balance_transaction",
"source": "re_123",
"status": "pending",
"created": 12345,
"currency": "usd",
"description": "REFUND FOR CHARGE (2 per month)",
"fee_details": [],
"available_on": 12345,
"exchange_rate": null,
"reporting_category": "refund"
},
"source_transfer_reversal": null
}
],
"object": "list",
"has_more": false,
"total_count": 1
},
"captured": true,
"currency": "usd",
"customer": "cus_123",
"disputed": false,
"livemode": true,
"metadata": {
"name": "John Doe",
"email": "[email protected]",
"order": "order_123",
"country": "US",
"school_id": "12345",
"product_id": "12345",
"course_name": "Whipped Cream 101",
"product_name": "2 per month"
},
"refunded": true,
"shipping": null,
"application": null,
"description": "2 per month",
"destination": null,
"receipt_url": "https://pay.stripe.com/receipts/acct_123/ch_123",
"failure_code": null,
"on_behalf_of": null,
"fraud_details": {},
"receipt_email": null,
"transfer_data": null,
"payment_intent": "pi_123",
"payment_method": "pm_123",
"receipt_number": null,
"transfer_group": null,
"amount_captured": 200,
"amount_refunded": 200,
"application_fee": null,
"billing_details": {
"name": "John Doe",
"email": "[email protected]",
"phone": null,
"address": {
"city": null,
"line1": null,
"line2": null,
"state": null,
"country": null,
"postal_code": "12345"
}
},
"failure_message": null,
"source_transfer": null,
"balance_transaction": {
"id": "txn_123",
"fee": 0,
"net": 200,
"type": "charge",
"amount": 200,
"object": "balance_transaction",
"source": "ch_123",
"status": "pending",
"created": 12345,
"currency": "usd",
"description": "2 per month",
"fee_details": [],
"available_on": 123445,
"exchange_rate": null,
"reporting_category": "charge"
},
"statement_descriptor": "The Sweet Shop",
"application_fee_amount": null,
"payment_method_details": {
"card": {
"iin": null,
"brand": "visa",
"last4": "1234",
"checks": {
"cvc_check": "pass",
"address_line1_check": null,
"address_postal_code_check": "pass"
},
"issuer": "Card Issuer Here",
"wallet": null,
"country": "US",
"funding": "debit",
"mandate": null,
"network": "visa",
"exp_year": 2025,
"exp_month": 1,
"description": "Visa Classic",
"fingerprint": "ABC123",
"installments": null,
"three_d_secure": null
},
"type": "card"
},
"failure_balance_transaction": null,
"statement_descriptor_suffix": null,
"calculated_statement_descriptor": "THE SWEET SHOP"
},
"vat_fees": 0,
"usd_conversion_rate": null,
"school_plan_id": 218,
"shipping_address": {
"id": 12345,
"line1": "123 Main Street",
"line2": null,
"city": "Anytown",
"region": "CA",
"postal_code": "12345",
"country": "US",
"school_id": 12345,
"created_at": "2022-05-27T19:03:52Z",
"updated_at": "2022-05-27T19:03:52Z"
},
"sale": {
"id": 12345,
"price": 200,
"currency": "USD",
"is_active": true,
"is_recurring": true,
"user_id": 12345,
"school_id": 12345,
"final_price": 200,
"shipping_address": {
"id": 12345,
"line1": "123 Main Street",
"line2": null,
"city": "Anytown",
"region": "CA",
"postal_code": "12345",
"country": "US",
"school_id": 12345,
"created_at": "2022-05-27T19:03:52Z",
"updated_at": "2022-05-27T19:03:52Z"
},
"course": {
"id": 12345,
"name": "Whipped Cream 101",
"url": "https://the-sweet-shop.teachable.com/courses/1234",
"friendly_url": "friendly-url-here",
"meta_description": null,
"description": null,
"author_bio": {
"created_at": "2021-06-16T19:58:00Z",
"profile_image_url": null,
"bio": "",
"position": null,
"user_id": null,
"name": "author name",
"id": 12345,
"meta": {
"class": "authorbio",
"url": "/author_bios/12345",
"name": "author name",
"description": "",
"image_url": null,
"status": null
},
"user_name": "",
"user_is_owner": null,
"user_has_custom_role": null
}
},
"product": {
"id": 12345,
"is_recurring": true,
"price": 200,
"name": "2 per month",
"currency": "USD"
},
"user": {
"id": 12345,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 12345,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": "2022-05-27T14:46:58Z",
"sign_in_count": 3,
"unsubscribe_from_marketing_emails": true
},
"coupon": null,
"affiliate": null,
"transactions": [
{
"created_at": "2022-05-27T19:04:00Z",
"custom_gateway?": false,
"fully_refunded?": true,
"is_stripe_connect?": false,
"is_custom_paypal?": false,
"is_teachable_payments?": false,
"charged_back_at": null,
"reserves": [],
"first_charge_on_sale?": true,
"has_fraud_warning?": false,
"purchased_item_name": "Whipped Cream 101",
"purchased_item_id": 1440378,
"purchased_item_type": "Course",
"purchaser_business_name": null,
"order_bump": null,
"order_bump_formatted_offer_price": null,
"usable_fee_ratio": 1,
"upsell_offer_id": null,
"user_id": 12345,
"final_price": 200,
"currency": "USD",
"affiliate_percent": 0,
"author_percent": 0,
"author_id": null,
"teachable_percent": 0,
"teachable_processor_fee": 0,
"amount_refunded": 200,
"status": "paid",
"affiliate_fees": 0,
"author_fees": 0,
"sale_id": 12345,
"coupon_id": null,
"net_charge": 0,
"earnings_usd": 0,
"net_charge_usd": 0,
"teachable_fixed_fee": 0,
"total_teachable_fee": 0,
"teachable_gateway_fee": 0,
"is_recurring": true,
"stripe_charge_token": "ch_123",
"paypal_payment_id": null,
"paypal_subscription_id": null,
"stripe_invoice_id": null,
"purchased_at": "2022-05-27T19:03:59Z",
"refundable": false,
"vat_fees": 0,
"is_chargeback": null,
"id": 12345,
"net_tax_charge": 0,
"original_product_charge_usd": 200,
"net_product_charge_usd": 0,
"marketplace_affiliate_id": null,
"marketplace_affiliate_fees": 0,
"marketplace_teachable_fees": 0,
"teachable_generated_lead_fee_percent": null,
"chargeback_fee": null,
"back_office_fee_percent": "0.02",
"back_office_fee": 0,
"fee_details": {
"base": "30",
"rate": "0.029",
"cross_border": "false",
"payment_method": "stripe",
"cross_border_assessed": "true"
},
"school_receives_vat_fees": null,
"meta": {
"class": "transaction",
"url": null,
"name": "20594068",
"description": "",
"image_url": null,
"status": "paid"
}
}
]
},
"user": {
"id": 12345,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 12345,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": "2022-05-27T14:46:58Z",
"sign_in_count": 3,
"unsubscribe_from_marketing_emails": true
},
"coupon": null
}
}
]
[
{
"type": "User.created",
"id": 123456,
"livemode": true,
"created": "2022-05-27T14:46:56+00:00",
"hook_event_id": 1234567,
"object": {
"id": 1234567,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 12345,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": null,
"sign_in_count": 1,
"unsubscribe_from_marketing_emails": true
}
}
]
[
{
"type": "User.subscribe_to_marketing_emails",
"id": 1234567,
"livemode": true,
"created": "2022-05-27T18:25:53+00:00",
"hook_event_id": 12345678,
"object": {
"id": 123456,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 12345,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": "2022-05-27T14:46:56Z",
"sign_in_count": 2,
"unsubscribe_from_marketing_emails": false
}
}
]
[
{
"type": "User.unsubscribe_from_marketing_emails",
"id": 123456,
"livemode": true,
"created": "2022-05-27T18:29:10+00:00",
"hook_event_id": 1234567,
"object": {
"id": 123456,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 123456,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": "2022-05-27T14:46:56Z",
"sign_in_count": 2,
"unsubscribe_from_marketing_emails": true
}
}
]
[
{
"type": "User.updated",
"id": 123456,
"livemode": true,
"created": "2022-05-27T18:29:31+00:00",
"hook_event_id": 12345678,
"object": {
"id": 1234567,
"role": "student",
"email": "[email protected]",
"name": "John Doe",
"school_id": 12345,
"src": null,
"first_touch": null,
"last_touch": null,
"last_sign_in_at": "2022-05-27T14:46:56Z",
"sign_in_count": 2,
"unsubscribe_from_marketing_emails": true,
"new_name": "John Doe",
"old_name": "Jane Doe"
}
}
]
[
{
"type": "UserTag.created",
"id": 12345,
"livemode": true,
"created": "2022-05-27T18:54:27+00:00",
"hook_event_id": 12345678,
"object": {
"school_id": 123456,
"user_id": 1234567,
"user_email": "[email protected]",
"tag_id": 1234,
"tag_name": "tag name"
}
}
]
[
{
"type": "UserTag.removed",
"id": null,
"livemode": true,
"created": "2022-05-27T18:56:29+00:00",
"hook_event_id": 123456,
"object": {
"tag_id": 1234,
"user_id": 1234567,
"tag_name": "tag name",
"school_id": 12345,
"user_email": "[email protected]"
}
}
]
[
{
"type": "AbandonedOrder.created",
"id": 123456,
"livemode": true,
"created": "2023-03-07T19:50:07+00:00",
"hook_event_id": 123456,
"object": {
"checkout_url": "https://the-sweet-shop.teachable.com/courses/123422,
"currency": "USD",
"main_product_name": "Whipped Cream 101",
"main_product_price:": 4000,
"user_email": "[email protected]",
"order_token": "order_0123456",
"order_bumps":[
{
"name": "Cake Pops 101",
"price": 2000
}
]
}
}
]
Updated over 1 year ago