Thinkific Help Center

https://support.thinkific.dev/hc/en-us
Admin
The Thinkific Help Center provides resources, FAQs, and guides to help users successfully create...
Tokens:310,448
Snippets:3,924
Trust Score:5
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example App Installation URL

Source: https://support.thinkific.dev/hc/en-us/articles/6457501369367-How-do-I-set-up-my-App-to-be-installed-in-the-Thinkific-App-Store

An example of a complete installation URL, demonstrating how the APP_URL and THINKIFIC_SUBDOMAIN parameters are substituted.

```text
https://my.cool.app/install?subdomain=aweseome-academy
```

--------------------------------

### App Installation URL with Example Subdomain

Source: https://support.thinkific.dev/hc/en-us/articles/4422686001943

This is a concrete example of the installation URL, showing how a specific Thinkific subdomain is incorporated. This helps in understanding the dynamic nature of the redirect.

```plaintext
https://my.cool.app/install?subdomain=cool-academy
```

--------------------------------

### App Installation URL Example

Source: https://support.thinkific.dev/hc/en-us/articles/4422686001943

This URL format is used when a user installs an app from the Thinkific App Store. Your app should be ready to receive this request and initiate the OAuth flow.

```plaintext
#{APP_URL}/install?subdomain={THINKIFIC_SUBDOMAIN}
```

--------------------------------

### Authorization Header Example

Source: https://support.thinkific.dev/hc/en-us/articles/4422658129175

Example of the Authorization header using Base64 encoded credentials.

```http
Authorization: Basic Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=
```

--------------------------------

### GraphQL Rate Limit Response Example

Source: https://support.thinkific.dev/hc/en-us/articles/22113098742935

An example of a GraphQL query and its corresponding response, which includes rate limit metadata within the extensions object.

```graphql
# Get users and their courses  
query UsersAndCoursesQuery {  
  site {  
    users(first: 25) {  
      nodes {  
        id  
        firstName  
        courses(first: 10) {  
          nodes {  
            id  
            title  
          }  
        }  
      }  
    }  
  }  
}
```

```json
{
  "data": {
    "site": {
      "users": {
        "nodes": [
          // 25 users
        ]
      }
    }
  },
    "extensions": {
      "rateLimit": {
        "cost": 206,
        "remaining": 1794,
        "resetAt": "2023-12-11T19:53:00.000Z",
        "limit": 2000
      }
    }
  }
```

--------------------------------

### Example: Implementing data-preview-item in a Banner Section

Source: https://support.thinkific.dev/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCJe10QMGBDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCBfkdRbeBToLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSI8L2hjL2VuLXVzL2FydGljbGVzLzQ0MjM4ODAzOTAwMzktU2l0ZS1CdWlsZGVyLVByZXZpZXdlcgY7CFQ6CXJhbmtpCg%3D%3D--3377e82e37c3d83514b9e509c8bc58ebfa09c075

This example demonstrates how to add the 'data-preview-item' attribute to a custom 'banner' section file, ensuring it works with the Site Builder Previewer. It includes various utility includes common in Thinkific themes.

```html
<section class=
  " 
    banner
    {% include 'section_utility_background' %}
    {% include 'section_utility_content_alignment' %}
    {% include 'section_utility_height_preset' %}
    {% include 'section_utility_has_additional_prices' %}
    {% include 'section_utility_has_free_trial' %}
  "
  data-preview-item="banner"
>

```

--------------------------------

### App Store Installation Redirect URL

Source: https://support.thinkific.dev/hc/en-us/articles/4422686001943-Creating-an-App

The URL structure used by the Thinkific App Store to redirect users to your application for installation.

```text
#{APP_URL}/install?subdomain={THINKIFIC_SUBDOMAIN}
```

```text
https://my.cool.app/install?subdomain=cool-academy
```

--------------------------------

### Install Thinkific App Frames Remote via npm or yarn

Source: https://support.thinkific.dev/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCJfkF3hsBDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCBcEI3%2F5CDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSI%2BL2hjL2VuLXVzL2FydGljbGVzLzQ4NjM5MTc4MTA4MzktQnVpbGRpbmctYW4tRW1iZWRkZWQtQXBwBjsIVDoJcmFua2kH--f21ae9c3456e28231baa3498ba87ce5d7c7d4778

Install the Thinkific app frames remote library locally using npm or yarn. This is for local installation.

```bash
npm install @thinkific/app-frames-remote
```

```bash
yarn add @thinkific/app-frames-remote
```

--------------------------------

### Product Lifecycle Webhook Payloads

Source: https://support.thinkific.dev/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCBdG%2BroFBDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJevsZkECjoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSI8L2hjL2VuLXVzL2FydGljbGVzLzQ0MjI2NTgzMTE3MDMtV2ViaG9va3MtRG9jdW1lbnRhdGlvbgY7CFQ6CXJhbmtpBw%3D%3D--358cdce20372ce0b4e3f6fc7d8f591da87e85d79

Example payloads for product created, updated, and deleted events.

```json
{
  "id": "01G2Z97HB88R49AXA13MS25C6J",
  "resource": "product",
  "action": "created",
  "tenant_id": "3147",
  "tenant_global_id": "e46fad25-02e3-4539-a989-bab075b09f12",
  "created_at": "2022-05-13T17:59:57.000Z",
  "timestamp": 1652464797,
  "payload": {
    "id": 12938,
    "productable_id": 650,
    "productable_type": "Bundle",
    "status": "published",
    "name": "API Bundle of Joy",
    "private": false,
    "hidden": false,
    "slug": "my-bundle",
    "card_image_url": "https://import.cdn.thinkific-staging.com/3147/xfaPbIi8TXKwynWCNfLg_Neymar-665.png",
    "created_at": "2019-09-18T23:09:11.438Z",
    "updated_at": "2022-05-13T17:59:25.753Z",
    "product_prices": [
    {
      "id": 14020,
      "is_primary": true,
      "payment_type": "one-time",
      "label": null,
      "price": "99.99",
      "days_until_expiry": null,
      "pay_button_text": null,
      "number_of_payments": null,
      "interval": null,
      "interval_count": null,
      "trial_interval": null,
      "trial_interval_count": null
    }
  ],
  "description": "This is a bundle with great courses about APIs, come and learn more about it!",
  "site": {
    "id": "e46fad25-02e3-4539-a989-bab075b09f12"
    }
  }
}
```

```json
{
  "id": "01FWRQ2HCQ05N62BTRMPZGH29F",
  "resource": "product",
  "action": "deleted",
  "created_at": "2022-02-25T15:13:01.000Z",
  "timestamp": 1645801981,
  "payload": {
    "site": {
      "id": "3088d468-983d-4fe4-8bc2-b98a6d2d78a8"
    },
    "id": 28570,
    "productable_id": 27309,
    "productable_type": "Course"
  }
}
```

```json
{
  "id": "01G2Z97HB88R49AXA13MS25C6J",
  "resource": "product",
  "action": "updated",
  "tenant_id": "3147",
  "tenant_global_id": "e46fad25-02e3-4539-a989-bab075b09f12",
  "created_at": "2022-05-13T17:59:57.000Z",
  "timestamp": 1652464797,
  "payload": {
    "id": 12938,
    "productable_id": 650,
    "productable_type": "Bundle",
    "status": "published",
    "name": "API Bundle of Joy",
    "private": false,
    "hidden": false,
    "slug": "my-bundle",
    "card_image_url": "https://import.cdn.thinkific-staging.com/3147/xfaPbIi8TXKwynWCNfLg_Neymar-665.png",
    "created_at": "2019-09-18T23:09:11.438Z",
    "updated_at": "2022-05-13T17:59:25.753Z",
    "product_prices": [
    {
      "id": 14020,
      "is_primary": true,
      "payment_type": "one-time",
      "label": null,
      "price": "99.99",
      "days_until_expiry": null,
      "pay_button_text": null,
      "number_of_payments": null,
      "interval": null,
      "interval_count": null,
      "trial_interval": null,
      "trial_interval_count": null
    }
  ],
  "description": "This is a bundle with great courses about APIs, come and learn more about it!",
  "site": {
    "id": "e46fad25-02e3-4539-a989-bab075b09f12"
    }
  }
}
```

--------------------------------

### User Signup Webhook Payload

Source: https://support.thinkific.dev/hc/en-us/articles/4422658311703-Webhooks-Documentation

Example payload for a user signup event.

```json
{
  "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 Trial Event

Source: https://support.thinkific.dev/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCBdG%2BroFBDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJd8nrwFBDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSI8L2hjL2VuLXVzL2FydGljbGVzLzQ0MjI2NTgzMTE3MDMtV2ViaG9va3MtRG9jdW1lbnRhdGlvbgY7CFQ6CXJhbmtpBg%3D%3D--9de94ba9ce3b2eb51bfc05a0e133ec1fdbf99e66

This event is triggered when a user starts a trial enrollment for a course.

```APIDOC
## Enrollment Trial Event

### Description
This webhook event is triggered when a user begins a trial enrollment for a course. It provides details about the user, the course, and the trial status.

### Method
POST

### Endpoint
/webhooks/enrollment/trial

### Request Body
- **id** (string) - Required - Unique identifier for the event.
- **resource** (string) - Required - The resource type, which is 'enrollment'.
- **action** (string) - Required - The action performed, which is 'trial'.
- **tenant_id** (string) - Required - The ID of the tenant.
- **created_at** (string) - Required - Timestamp of when the event was created.
- **payload** (object) - Required - Contains details about the enrollment.
  - **activated_at** (string) - Optional - Timestamp when the enrollment was activated.
  - **completed_at** (string) - Optional - Timestamp when the enrollment was completed.
  - **course** (object) - Required - Information about the course.
    - **id** (integer) - Required - The unique ID of the course.
    - **name** (string) - Required - The name of the course.
  - **course_id** (integer) - Required - The ID of the course.
  - **created_at** (string) - Required - Timestamp of when the enrollment was created.
  - **expiry_date** (string) - Optional - The expiration date of the enrollment.
  - **free_trial** (boolean) - Required - Indicates if the enrollment is a free trial.
  - **id** (integer) - Required - The unique ID of the enrollment.
  - **percentage_completed** (string) - Required - The completion percentage of the course.
  - **started_at** (string) - Required - Timestamp when the enrollment was started.
  - **updated_at** (string) - Required - Timestamp of when the enrollment was last updated.
  - **user** (object) - Required - Information about the user.
    - **email** (string) - Required - The email address of the user.
    - **first_name** (string) - Required - The first name of the user.
    - **id** (integer) - Required - The unique ID of the user.
    - **last_name** (string) - Required - The last name of the user.

### Request Example
```json
{
  "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"
    }
  }
}
```
```

--------------------------------

### POST /enrollments

Source: https://support.thinkific.dev/hc/en-us/articles/10488513776023-Why-are-students-enrolled-through-the-API-only-added-to-a-preview-and-not-the-full-course

Enrolls a user into a course. To enroll in the full course, an `activated_at` value must be provided. Otherwise, the user will be enrolled in the free preview.

```APIDOC
## POST /enrollments

### Description
Enrolls a user into a course. If the `activated_at` field is not included in the request body, the user will be enrolled in the free preview of the course. To enroll the user in the full course, a valid `activated_at` timestamp must be provided.

### Method
POST

### Endpoint
/enrollments

### Request Body
- **user_id** (integer) - Required - The ID of the user to enroll.
- **course_id** (integer) - Required - The ID of the course to enroll the user in.
- **activated_at** (string) - Optional - A valid ISO 8601 timestamp string (e.g., "2023-10-27T10:00:00Z"). If omitted, the user is enrolled in the free preview.

### Request Example
```json
{
  "user_id": 12345,
  "course_id": 67890,
  "activated_at": "2023-10-27T10:00:00Z"
}
```

### Response
#### Success Response (201 Created)
- **id** (integer) - The unique identifier for the enrollment.
- **user_id** (integer) - The ID of the user enrolled.
- **course_id** (integer) - The ID of the course.
- **activated_at** (string) - The timestamp when the enrollment was activated (or null if in preview).

#### Response Example
```json
{
  "id": 98765,
  "user_id": 12345,
  "course_id": 67890,
  "activated_at": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### JWKS response example

Source: https://support.thinkific.dev/hc/en-us/articles/4422685802903

Example structure of a JWKS response containing RSA public keys.

```json
{
  "keys": [
    {
      "kty": "RSA",
      "n": "37jh10J64WrNKRDk6_-paqBwFg0ewvBzIX1pPFlxJ6AOf7e-jDIQ1GgJ7i-pB8FG8rj4gdy-JNqRRUj_jQV_eAUGCphX2_Ut4y0MznPMKfoFP__-Cr05oR2xsV3C_bc9lkkV74rAuDSA0DPhZ04nJieDpoURh_jZy7LLiks4WMbv5nJTpiW6As8zaNVDKFf7PDeXlbI2x-LPuI2S2EHePWyC4_PbXmeJmPiywnKjfRSGKyPVAamsZmJ6Mh79SAACD7SBvykWDRfYqSCw7UCwoKPWhB_9harsIWbxer4_PJSCgbdfbBRgfgCzCPS4xS5hB2iRDc5s-cqlgHDVj6fDZQ",
      "e":"AQAB",
      "kid":"54299cd7b7ca111a02b8a5cfbcb653ad2a1afe1ef8a97536621ca3e4c410c668"
    }
  ]
}
```

--------------------------------

### GraphQL Query for Users and Courses

Source: https://support.thinkific.dev/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCJc8ZZscFDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCBcmpUwcFDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSJAL2hjL2VuLXVzL2FydGljbGVzLzIyMTEzMDk4NzQyOTM1LUdyYXBoUUwtUXVlcnktTGltaXRhdGlvbnMGOwhUOglyYW5raQc%3D--7fa9dcd69ceb50f890bcd045e90eca7218f00b8f

This example shows a GraphQL query to retrieve users and their associated courses. It includes pagination parameters for both users and courses. The response includes rate limiting information under the 'extensions' key.

```graphql
# Get users and their courses
query UsersAndCoursesQuery {
  site {
    users(first: 25) {
      nodes {
        id
        firstName
        courses(first: 10) {
          nodes {
            id
            title
          }
        }
      }
    }
  }
}
```

```json
{
  "data": {
    "site": {
      "users": {
        "nodes": [
          // 25 users
        ]
      }
    }
  },
    "extensions": {
      "rateLimit": {
        "cost": 206,
        "remaining": 1794,
        "resetAt": "2023-12-11T19:53:00.000Z",
        "limit": 2000
      }
    }
  }
```

--------------------------------

### Configure App Section Description

Source: https://support.thinkific.dev/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCJdmdgMGBDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJeGBY%2ByCToLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSI2L2hjL2VuLXVzL2FydGljbGVzLzQ0MjM4NzQ0MDYwMzktVGhlbWUtRXh0ZW5zaW9ucwY7CFQ6CXJhbmtpCg%3D%3D--c35db6fac54f4e23106119ec6d5d19dbed6a5e3d

Use this schema to define the label, description, and preview for an app section. The description can include HTML for rich content like links, images, and embedded videos.

```json
{
  "label":"Astronauts",
  "description":"This is an astronauts app! <br/> For more details, visit our <a href='example.com'>website</a>. <br/> <br/> <img src='https://cdn.britannica.com/35/210535-050-60B90533/Roberta-Bodnar-Canadian-astronaut.jpg' width='200px' /> <br/> <br/> <iframe width='320' height='180' src='https://www.youtube.com/embed/CAxlduB68T4' frameborder='0' allow='accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture' allowfullscreen></iframe>",
  "previewImageUrl":"https://cdn.thinkific.com/57/20210222/bd6ff9e981480e3e5327fd4ee1b2e9ff.png",
  "previewDescription":"This section is only for Astronauts",
  "settings":[]
}
```

--------------------------------

### Webhook Payload Example: Order Created

Source: https://support.thinkific.dev/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCBdG%2BroFBDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJcNf3GfBDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSI8L2hjL2VuLXVzL2FydGljbGVzLzQ0MjI2NTgzMTE3MDMtV2ViaG9va3MtRG9jdW1lbnRhdGlvbgY7CFQ6CXJhbmtpBg%3D%3D--e727499475199f9c070303ae9fd2bc641153ae41

This is an example payload for the 'Order Created' webhook topic. Note that `net_amount` is only returned for Thinkific Payments.

```APIDOC
## Webhook Payload Example: Order Created

### Payload
```json
{
  "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": {
      "id": 12345678,
      "code": "discount123",
      "promotion_id": 1234567
    },
    "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",
    "items": [
      {
        "product_id": 1,
        "product_name": "Introduction to Webhooks",
        "amount_dollars": 50,
        "amount_cents": 5000
      }
    ],
    "net_amount": 1234,
    "presentment_amount": 15896,
    "presentment_currency": "cad",
    "user": {
      "email": "ninjas@thinkific.com",
      "first_name": "Robert",
      "id": 123456,
      "last_name": "Smith"
    }
  }
}
```

Note: The `net_amount` is only returned for payments made using Thinkific Payments. Any payments made through other means return `null`.
```

--------------------------------

### Prelaunch Page

Source: https://support.thinkific.dev/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCBf14gMGBDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCBeTdgQGBDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSI2L2hjL2VuLXVzL2FydGljbGVzLzQ0MjM4ODE1MjA0MDctTGlxdWlkLUFQSS1QYWdlcwY7CFQ6CXJhbmtpBw%3D%3D--e725ef6b8f6687b479d56ba54aeaedfabef387de

Displayed when a tenant has no published courses, used for capturing new leads' email addresses.

```APIDOC
## Prelaunch Page

### Description
This page is shown instead of the homepage if the tenant does not have any published courses yet. It is used to capture email address of new leads.

### Locators
- **page.page_identifier** (String) - The unique identifier for this page
```

--------------------------------

### Example: Track Content Completion with JavaScript

Source: https://support.thinkific.dev/hc/en-us/articles/4423909497367-Course-Player-Event-Hooks

This script listens for the 'hooks:contentWasCompleted' event and tracks the event with custom analytics. Ensure the CoursePlayerV2 object is available before attaching the event listener.

```javascript
<script>
  $(function() {
    if(typeof(CoursePlayerV2) !== 'undefined') {
      CoursePlayerV2.on('hooks:contentWasCompleted', function(data) {
        data["user"] = Thinkific.current_user;
        ThinkificAnalytics.track("Custom Content Completed", data);
      });
    }
  });
</script>
```

--------------------------------

### Webhooks API - Example Payloads

Source: https://support.thinkific.dev/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCBdG%2BroFBDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCBfRDTJdCDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSI8L2hjL2VuLXVzL2FydGljbGVzLzQ0MjI2NTgzMTE3MDMtV2ViaG9va3MtRG9jdW1lbnRhdGlvbgY7CFQ6CXJhbmtpCA%3D%3D--8a87b72e8b4930490af27f063327cfa56b809d53

These are example payloads for common webhook events. Understanding these payloads will help you process the data sent by Thinkific when an event occurs.

```APIDOC
## Example Payloads

### Lead Created

#### Payload
```json
{
  "id": "01J04SSDPGJC6TK3Q3TKZS7C8R",
  "resource": "lead",
  "action": "created",
  "tenant_id": "3",
  "tenant_global_id": "31xx00x2-x2x8-00x0-xxx0-000x2xx6xxx0",
  "created_at": "2024-06-11T23:23:03.000Z",
  "timestamp": 1718148183,
  "payload": {
    "id": 33,
    "user_gid": "",
    "created_at": "2024-06-11T23:23:03.758Z",
    "first_name": "[TEST] John",
    "last_name": "Doe",
    "email": "[TEST] john@doe.com",
    "site": {
      "id": "31xx00x2-x2x8-00x0-xxx0-000x2xx6xxx0"
    },
    "subscribed": true
  }
}
```

### Order Created

#### Payload
```json
{
  "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": {
      "id": 12345678,
      "code": "discount123",
      "promotion_id": 1234567
    },
    "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",
    "items": [
      {
        "product_id": 1,
        "product_name": "Introduction to Webhooks",
        "amount_dollars": 50,
        "amount_cents": 5000
      }
    ],
    "net_amount": 1234,
    "presentment_amount": 15896,
    "presentment_currency": "cad",
    "user": {
      "email": "ninjas@thinkific.com",
      "first_name": "Robert",
      "id": 123456,
      "last_name": "Smith"
    }
  }
}
```

Note: The `net_amount` is only returned for payments made using Thinkific Payments. Any payments made through other means return `null`.
```

--------------------------------

### Install Thinkific App Frames Remote via Package Manager

Source: https://support.thinkific.dev/hc/en-us/articles/4863917810839

Install the required package locally using npm or yarn to access Thinkific's embedded app functionality.

```bash
npm install @thinkific/app-frames-remote

OR

yarn add @thinkific/app-frames-remote
```

--------------------------------

### CDN Installation for Toast Notifications

Source: https://support.thinkific.dev/hc/en-us/articles/4863917810839-Building-an-Embedded-App

Use this script tag for CDN installation to enable Thinkific's toast notifications in your embedded app. This ensures a consistent user experience for success and error messages.

```html
<script type="module">
  import { toast } from 'https://cdn.thinkific.com/assets/app-frames/remote/latest/index.js';
</script>
```

--------------------------------

### Make a Test API Request

Source: https://support.thinkific.dev/hc/en-us/articles/4422657425431-Authorization-using-API-Key

Use this cURL command to test your API connection by retrieving a list of courses. Replace placeholders with your actual API key and subdomain.

```bash
curl https://api.thinkific.com/api/public/v1/courses \
-H 'X-Auth-API-Key: my-api-key' \
-H 'X-Auth-Subdomain: my-subdomain' \
-H 'Content-Type: application/json'
```

--------------------------------

### Local Installation for Toast Notifications (yarn)

Source: https://support.thinkific.dev/hc/en-us/articles/4863917810839-Building-an-Embedded-App

Install the app-frames-remote package locally using yarn to utilize Thinkific's toast notifications. This is required for consistent success and error message display within your embedded app.

```bash
yarn add @thinkific/app-frames-remote
```

--------------------------------

### User Signup Event

Source: https://support.thinkific.dev/hc/en-us/articles/4422658311703-Webhooks-Documentation

This event is triggered when a new user signs up.

```APIDOC
## User Signup Event

### Description
This event is triggered when a new user registers for an account. It contains the details of the newly created user.

### Payload
```json
{
  "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": []
  }
}
```
```

--------------------------------

### Local Installation for Toast Notifications (npm)

Source: https://support.thinkific.dev/hc/en-us/articles/4863917810839-Building-an-Embedded-App

Install the app-frames-remote package locally using npm to utilize Thinkific's toast notifications. This is required for consistent success and error message display within your embedded app.

```bash
npm install @thinkific/app-frames-remote
```

--------------------------------

### Site Scripts API Reference

Source: https://support.thinkific.dev/hc/en-us/articles/22112790485655

Documentation for customizing the course player using Site Scripts.

```APIDOC
## Site Scripts API

- **Site Scripts API Reference**: Details on available scripts and their functionalities.
- **Course Player Customizations**: How to modify the course player interface.
- **Course Player Event Hooks**: Utilizing events within the course player.
```

--------------------------------

### GET /users

Source: https://support.thinkific.dev/hc/en-us/articles/4422685833751-Permissions-and-Scopes

Retrieve user information.

```APIDOC
## GET /users

### Description
View information about users. Note that Users [General] returns non-identifiable information, while Users [Profile] includes personal identifiable information.

### Method
GET

### Endpoint
/users
```

--------------------------------

### GET /coupons

Source: https://support.thinkific.dev/hc/en-us/articles/4422685833751-Permissions-and-Scopes

Retrieve a list of coupons.

```APIDOC
## GET /coupons

### Description
View all coupons.

### Method
GET

### Endpoint
/coupons
```

--------------------------------

### Example Pagination Response

Source: https://support.thinkific.dev/hc/en-us/articles/22165751704983-GraphQL-Pagination

A sample JSON response showing the structure of paginated data and rate limit information.

```json
{
  "data": {
    "site": {
      "courses": {
        "edges": [
          {
            "node": {
              "id": "1638969",
              "name": "Advanced Flossing"
            }
          },
          {
            "node": {
              "id": "1631202",
              "name": "Introduction to Flossing"
            }
          }
        ],
        "pageInfo": {
          "endCursor": "Nw",
          "hasNextPage": false
        }
      }
    }
  },
  "extensions": {
    "rateLimit": {
      "cost": 3,
      "remaining": 1997,
      "resetAt": "2024-04-01T21:23:00.000Z",
      "limit": 2000
    }
  }
}
```

--------------------------------

### GET /orders

Source: https://support.thinkific.dev/hc/en-us/articles/4422685833751

Retrieve the order history for the account.

```APIDOC
## GET /orders

### Description
View order history.

### Method
GET

### Endpoint
/orders
```

--------------------------------

### Site Page Schema Example

Source: https://support.thinkific.dev/hc/en-us/articles/4423875019159

A Site Page must include a schema with a 'sections' object to define available sections and the 'content_for_page' variable for custom section injection.

```json
{
  "schema": {
    "sections": {
      "my_custom_section": {
        "name": "My Custom Section",
        "settings": [
          {
            "type": "text",
            "id": "my_text_setting",
            "label": "My Text Setting",
            "default": "Hello, world!"
          }
        ]
      }
    },
    "content_for_page": "{{ content_for_page }}"
  }
}
```

--------------------------------

### GET /courses

Source: https://support.thinkific.dev/hc/en-us/articles/4422685833751

Retrieve a list of all courses available in the account.

```APIDOC
## GET /courses

### Description
View all courses.

### Method
GET

### Endpoint
/courses
```

--------------------------------

### GraphQL User Query with Fragment

Source: https://support.thinkific.dev/hc/en-us/related/click?data=BAh7CjobZGVzdGluYXRpb25fYXJ0aWNsZV9pZGwrCBfCaaIpFDoYcmVmZXJyZXJfYXJ0aWNsZV9pZGwrCJc8ZZscFDoLbG9jYWxlSSIKZW4tdXMGOgZFVDoIdXJsSSI9L2hjL2VuLXVzL2FydGljbGVzLzIyMTY5MDUxMDU0NjE1LUdyYXBoUUwtQmVzdC1QcmFjdGljZXMGOwhUOglyYW5raQg%3D--ddaabdf87c2fd9d0f4ff4f93ad121145974bd669

Fetches the first 50 users and their associated information using the UserInfo fragment. Includes pagination details.

```graphql
query UserQuery {
  site {
    users (first:50) {
      edges {
        node {
          ...UserInfo
        }
      }
     pageInfo {
         hasNextPage
         endCursor
      }
    }
  }
}
```

--------------------------------

### Example CSS Asset Link

Source: https://support.thinkific.dev/hc/en-us/articles/4423893067287-Using-Assets-in-Custom-Themes

Demonstrates linking a specific CSS file, 'thinkific.css', uploaded to the theme's Assets folder, using the `theme_asset_url` filter.

```HTML
<link rel="stylesheet" type="text/css" href="{{ 'thinkific.css' | theme_asset_url }}">
```
Tokens:
Raw