How to use Webhooks in Knorish
Introduction
Webhooks are a powerful feature within Knorish that provides near-real-time information about specific events as they happen in your account. They allow you to automate workflows, share data, or build custom apps by sending an HTTP request to an endpoint you provide whenever a specific event occurs. Unlike regular API calls, which require you to poll for changes, webhooks push data to you automatically, making them more scalable and efficient.
How Do Webhooks Work?
Webhooks work on an event-based system, meaning they are triggered by specific actions within your Knorish account. For example, you can set up a webhook to send data to a third-party tool every time a user completes a course or makes a purchase. Once the event occurs, Knorish sends an HTTP POST request to the endpoint URL you provided, containing relevant data about the event.
Webhooks Available in Knorish
Knorish offers several event types that you can subscribe to via webhooks:
Webhook Event | Description |
Contact Form Submitted | Triggered when a visitor submits a contact form. |
Course Completed | Triggered when a student completes a course. |
New Signup | Triggered when a new user signs up on your platform. |
Course Purchased | Triggered when any course is purchased. |
Bundle Purchased | Triggered when any bundle is purchased. |
Live Session Joined | Triggered when a student joins a live session. |
Course Abandoned Cart | Triggered when a user abandons their cart and doesn't complete the transaction. |
Bundle Abandoned Cart | Triggered when a user abandons their cart before purchasing a bundle. |
How to access Webhooks section on Knorish and add yours?
Here's how to access the Webhooks section on your account:
- Login your account
- Access your publisher dashboard
- Click Settings > Webhook
- Choose from the list of webhooks available
- Paste the webhook endpoint URL in the appropriate textbox
- Click Test & Save to test your webhook and save the settings
Important consideration
- Endpoint Availability: Ensure that your endpoint is highly available to prevent any message loss. If your endpoint is down or unavailable when the event occurs, the data sent by the webhook may be lost.
- Testing Webhooks: For testing purposes, you can use services like webhook.site to view the payload and understand its structure.
- Webhooks and the Knorish API are advanced features. They typically involve the use of third-party applications and custom coding. While Knorish provides the tools necessary to set up and manage webhooks, our support team cannot offer assistance with third-party applications or custom code integrations.
Related Articles
Getting started - Publisher REST API
Knorish is home to tens of thousands of businesses, experts and course creators around the world that arebuilding a business using online education. At Knorish we ensure that all course creators have the tools and resources to solve the most ...
API Endpoints and Postman Dump - Publisher REST API
The list of API endpoints is self-explanatory, making it easier for you to navigate and comprehend. To gain a better understanding of the request and response body structure, you can download the Postman dump and try it out yourself. API Endpoint ...
Rate Limit - Publisher REST API
To ensure Knorish remains stable and accessible to all sites, we limit the number of requests per 5 minutes that any one Site can make to the API. Consumers of the API should take steps to ensure they are using industry standard techniques to ...
Request and response format - Publisher REST API
All data in request or response from the API is in JSON format. Request and response fields for every API endpoint will be different, and you will know about them individually. Date Format All dates and timestamps are returned and expected in ISO ...
Authorization using App Id and App Key - Publisher REST API
If you want a simple way to gain access to the API for an individual Knorish Site with the purpose of building a private or one-off app, you can authorize using the Knorish Site's App Id and App Key. Generate App ID and App Key To generate App Id and ...