Teachable API Essential Guide

What type of API does Teachable provide?

Based on the information available, it's most likely that Teachable uses a REST API. This inference is based on the following reasons:

1. REST APIs are the most common and widely used type of API for web services.
2. REST APIs are known for their flexibility and scalability, which aligns with Teachable's goal of supporting creators as they grow.
3. REST APIs are easy to learn and use, which would be beneficial for Teachable's creator community.
4. The features described, such as data sharing and workflow automation, are typical use cases for REST APIs.

However, without explicit confirmation from Teachable, we cannot be 100% certain about the API type. It's possible that Teachable could be using a different API type or a combination of API types, though this is less likely. For the most accurate information, it would be best to consult Teachable's API documentation or contact their support directly.

Does the Teachable API have webhooks?

Yes, the official Teachable API does have webhooks. Here are the key points about Teachable's webhook functionality:

Available Webhook Events

Teachable offers a wide range of events that you can subscribe to via webhooks. Some of the main event types include:

• New admission (Admission.created)
• New enrollment (Enrollment.created)
• New unenrollment (Enrollment.disabled)
• New sale (Sale.created)
• Subscription canceled (Sale.subscription_canceled)
• New transaction (Transaction.created)
• New user (User.created)
• User profile updated (User.updated)
• Abandoned cart (AbandonedOrder.created)

Event Types

The webhook events cover various aspects of course management and user interactions, including:

• Course-related events (enrollments, completions)
• User-related events (new users, profile updates)
• Financial events (sales, transactions, refunds)
• Marketing-related events (email subscriptions, abandoned carts)

Adding and Managing Webhooks

To set up a webhook, you need to:

1. Provide a Webhook URL (the endpoint that will receive the webhook data)
2. Configure the webhook payload setting (optional)
3. Select the specific webhook events you want to subscribe to

Webhook Status and History

Teachable provides detailed information about the status of each webhook, including:

• Event name
• Object ID
• Status (Success, Failed, Permanently Failed, Canceled)
• Date & Time of the event

Best Practices

1. Avoid creating duplicate webhooks. Webhooks with the same URL can be created, but they cannot subscribe to the same events.
2. Monitor the status of your webhooks to ensure they're functioning correctly.
3. Use the webhook history to troubleshoot any issues with webhook delivery.

Key Considerations

• Webhooks allow you to receive real-time updates about events in your Teachable school.
• You can use webhooks to integrate Teachable with other systems or automate processes based on specific events.
• Teachable provides detailed data payloads for each webhook event, allowing you to access relevant information about the triggered event.

By leveraging Teachable's webhook functionality, you can create more dynamic and responsive integrations with your Teachable school, enhancing your ability to manage courses, users, and transactions effectively.

Rate Limits and other limitations

Based on the search results provided, I could not find any specific information about API rate limits for the Teachable API. The search results primarily contain general information about the Teachable API and its usage, but do not mention rate limits explicitly.

However, I can provide some general information about the Teachable API based on the search results:

Key Points:

1. The Teachable API allows users to automate management of students and products, access advanced reporting, and connect to other tools for managing online businesses.

2. The API uses standard HTTP methods (GET, POST, PATCH, DELETE) for different actions on resources.

3. Requests to the API are made using the developers.teachable.com base URL.

4. Authentication is required for API requests, using an API key included in the header.

5. The API is available for Teachable accounts on the Pro plan or higher.

Best Practices:

1. Include the API key in the header of all requests for authentication.

2. Use the correct Content-Type header (application/json) when sending data in the request body.

3. Format request bodies in JSON for POST, PATCH, or DELETE requests.

4. Use parameters to specify requests when required by certain endpoints.

5. Consider using third-party GUI clients like Postman or Paw for making API requests.

While the search results do not provide information about Teachable API rate limits, it's common for APIs to have some form of rate limiting to ensure fair usage and system stability. If you need specific information about rate limits for the Teachable API, I recommend contacting Teachable support directly or checking their official documentation for any updates on this topic.

Latest API Version

Based on the search results provided, here is the most up-to-date information about the Teachable API:

The most recent version of the Teachable API appears to be the Public API that was launched in 2022. The search results do not specify an exact version number, but they provide information on recent updates and additions to the API:

Recent Updates

• August 11, 2023: Added email lookup to GET /users endpoint
• May 12, 2023: Added Course Progress endpoint
• May 4, 2023: Added Mark Lecture Complete endpoint
• April 24, 2023: Added Quizzes Endpoints
• April 20, 2023: Added POST /v1/courses/{course_id}/lectures/{lecture_id}/mark_complete endpoint
• April 14, 2023: Added GET /v1/current_user/courses/{course_id}/progress endpoint

Key Points

• The Teachable Public API is available for creators on Pro and Business plans
• The API allows creators to integrate and connect tools that help them run their businesses
• It enables data sharing, workflow automation, and creation of custom apps
• Teachable offers both webhooks and API to help automate school management and connect to other tools

Best Practices

1. Refer to the official Teachable Developer Hub for the most up-to-date information on API usage
2. Use the API Reference Documentation for detailed information on available endpoints
3. Consider using both webhooks and API together for more comprehensive automation
4. Be aware of the rate limits and pagination features when making API requests

For the most accurate and current information, it's recommended to check the official Teachable documentation or contact their support directly, as API versions and features may be updated regularly.

How to get a Teachable developer account and API Keys?

To get a developer account for Teachable and create an API integration, you need to follow these steps:

1. Sign up for a Teachable account

To use the Teachable API, you must have a Teachable account on the Pro plan or higher. You can sign up for a Teachable account at their website.

2. Upgrade to Pro plan or higher

Ensure your account is on the Pro plan or a higher tier, as the API is only available for these plans.

3. Get your API Key

Once you have a Pro account or higher:

1. Log in to your Teachable school admin dashboard.
2. Navigate to the Settings > API tab.
3. Here you will find your API key, which you'll need to authenticate your requests to the API.

4. Familiarize yourself with the API documentation

Teachable provides comprehensive documentation for their API:

• Review the quickstart guide to understand how to make API calls.
• Explore the available endpoints in the reference documentation.
• Check out use cases and tutorials for practical applications.

5. Start integrating

With your API key and knowledge of the documentation, you can now start integrating Teachable with your applications.

What can you do with the Teachable API?

Based on the search results provided, here is a list of data models you can interact with using the Teachable API, along with what is possible for each:

Users

• Create new students
• Search for users by email address
• Update existing student information

Courses

• Access course data
• Automate enrollment or unenrollment of students in courses

Schools

• Display Teachable school and product information on custom websites
• Access school data

Transactions

• Access robust sales and transaction reporting
• Pull transactions data into external tools like Google Sheets

Webhooks

• Set up and manage webhooks for various events
• Automate course enrollment sequences using webhooks

Key points to consider:

• The API allows for data sharing, workflow automation, and creation of custom apps
• It uses standard HTTP methods for indicating actions on resources
• Authentication is done using API keys
• The API is available for creators on Pro and Business plans
• Pagination is supported for handling large datasets
• Rate limits apply to API usage

Best practices:

• Use the API to integrate Teachable data with other tools and platforms for better business management
• Leverage the API for automating tasks to reduce manual work and improve student experience
• Consider creating custom applications to extend the functionality of your Teachable school
• Always follow the API documentation and adhere to rate limits and authentication requirements