Webhooks and API

This article introduces webhooks and the Teachable API. For more detailed information on how to access, use, and manage these features, refer to the Teachable Developer Hub.

NOTE: Note: Webhooks and the Teachable API are advanced features, and generally involve the use of third-party applications and custom coding. Third-party applications and custom code are not supported by Customer Support.

Overview

For advanced creators, webhooks and the Teachable API help you extend the power of Teachable by connecting it to the tools you already use to run your business.

Both of these tools can be used in ways that enable you to do things such as:

  • Share data
  • Automate workflows
  • Build custom apps

To understand the difference between webhooks and the API, refer to the below chart:

  API Webhooks
Plan availability Pro and up Basic and up
How it works Request-based— at any time, you can make a request to the API, which returns, creates, updates, or deletes data from your school based on the specifications of your request Event-based— once a specific trigger/event occurs in your Teachable school, data about the event is sent to the connected application
Example use case

Automatically add new users to your school, or enroll them into specific courses.

For a full list of available API endpoints, see the API Reference documentation.

Retrieve data each time a student completes a course in your school.

For a full list of available webhook events, see Webhook events and data.

For more detailed information on how to access, use, and manage these features, refer to the Teachable Developer Hub.

TIP: Webhooks and the Teachable API are advanced features. If you are looking for a developer or some assistance with using these tools, we recommend checking out Teachable Experts.

Webhooks

Webhooks are used to send information from one application (in this case, Teachable) to another. Webhooks are event-based — this means that they require a specific event, or trigger, to initiate the sending of data. For example, you can have an Enrollment Completed webhook that sends data from Teachable to a third-party each time a user completes a course in your school.

Webhooks are available on the Basic plan and up.

The following event types are available as Teachable webhooks:

  • New admission
  • Admission disabled
  • New comment
  • Email lead subscribed
  • Enrollment completed
  • New enrollment
  • New unenrollment
  • Lecture completed
  • New quiz response
  • New sale
  • Subscription cancelled
  • New transaction
  • Transaction refunded
  • New user
  • User opts in to marketing emails
  • User opts out of marketing emails
  • User profile updated
  • Tag added to user
  • Tag removed from user

For information on how to set up and manage webhooks, as well as sample return data for each webhook, check out the Teachable Developer Hub.

API

An API (Application Programming Interface) is a developer framework that allows you to share both data and functionality between two applications with custom coding. APIs are request-based—at any time, you can make a request to the API, which returns, creates, updates, or deletes data from your school based on the specifications of your request. For example, you can use the Teachable API to automatically add or enroll new users to your school, or to return detailed sales data.

The Teachable API is available to schools on the Pro plan or up.

For information on how to access and make requests to the API, and to see all available endpoints, check out the Teachable Developer Hub.

Was this article helpful?
24 out of 79 found this helpful
thanks_illustration

Thinking of joining? Contact Sales
Already a customer? Contact Support

thanks_illustration