Webhooks - Get updates in real-time
SuperPath uses webhooks to notify your application when an event happens in your account. Webhooks are particularly useful for asynchronous events like when an employee completes a learning, new content is added or a user earns learning points
Ready to go live? Register your webhook endpoint in Integration Settings so SuperPath knows where to deliver events.
A webhook enables SuperPath to push real-time notifications to your app. SuperPath uses HTTPS to send these notifications to your app as a JSON payload. You can then use these notifications to execute actions in your backend systems.
You can use webhook event notifications to alert your app:
That a new user was created. (user.created), so your app can add a new user
That a user has completed some learning content (learning.updated) so you can update an employees achievements
That a user has earned points (points.created) so you can update a leaderboard or rewards platform
You can start receiving event notifications in your app using the steps in this section:
Identify the events you want to monitor and the event payloads to parse.
Create a webhook endpoint as an HTTP endpoint (URL) on your local server.
Handle requests from SuperPath by parsing each event object and returning 2xx response status codes.
To test your webhook - reach out to SuperPath Support and they can configure a test environment for you to test
Deploy your webhook endpoint so it’s a publicly accessible HTTPS URL.
Register your publicly accessible HTTPS URL in the SuperPath Settings
Creating a webhook endpoint is no different from creating any other page on your website. It’s an HTTP or HTTPS endpoint on your server with a URL. If you’re still developing your endpoint on your local machine, it can be HTTP. After it’s publicly accessible, it must be HTTPS. You can use one endpoint to handle several different event types at once, or set up individual endpoints for specific events.
Identify the Types of Events and the The Event object your webhook endpoint needs to parse.
Set up an HTTP endpoint on your local machine that can accept unauthenticated webhook requests with a POST method.
Your endpoint must be configured to read an The Event object for the type of event notifications you want to receive. SuperPath sends events to your webhook endpoint as part of a POST request with a JSON payload.
Each event is structured as an event type, dateSent and data elements. Your endpoint must check the event type and parse the payload of each event.
Your endpoint must quickly return a successful status code (2xx) prior to any complex logic that could cause a timeout. For example, you must return a 200 response before updating your system with a users record.
SuperPath webhooks have built-in retry methods for 3xx, 4xx, or 5xx response status codes. If SuperPath doesn’t quickly receive a 2xx response status code for an event, we mark the event as failed and stop trying to send it to your endpoint. After multiple days, we email you about the misconfigured endpoint, and automatically disable it soon after if you haven’t addressed it.
Use Webhook Signature Authentication to verify that SuperPath generated a webhook request and that it didn’t come from a server acting like SuperPath.
Ready to go live? Register your webhook endpoint in Integration Settings so SuperPath knows where to deliver events.
What are webhooks
A webhook enables SuperPath to push real-time notifications to your app. SuperPath uses HTTPS to send these notifications to your app as a JSON payload. You can then use these notifications to execute actions in your backend systems.
Use cases
You can use webhook event notifications to alert your app:
That a new user was created. (user.created), so your app can add a new user
That a user has completed some learning content (learning.updated) so you can update an employees achievements
That a user has earned points (points.created) so you can update a leaderboard or rewards platform
Steps to receive webhooks
You can start receiving event notifications in your app using the steps in this section:
Identify the events you want to monitor and the event payloads to parse.
Create a webhook endpoint as an HTTP endpoint (URL) on your local server.
Handle requests from SuperPath by parsing each event object and returning 2xx response status codes.
To test your webhook - reach out to SuperPath Support and they can configure a test environment for you to test
Deploy your webhook endpoint so it’s a publicly accessible HTTPS URL.
Register your publicly accessible HTTPS URL in the SuperPath Settings
What is a webhook endpoint
Creating a webhook endpoint is no different from creating any other page on your website. It’s an HTTP or HTTPS endpoint on your server with a URL. If you’re still developing your endpoint on your local machine, it can be HTTP. After it’s publicly accessible, it must be HTTPS. You can use one endpoint to handle several different event types at once, or set up individual endpoints for specific events.
Step 1: Identify the events to monitor
Identify the Types of Events and the The Event object your webhook endpoint needs to parse.
Step 2: Create a webhook endpoint
Set up an HTTP endpoint on your local machine that can accept unauthenticated webhook requests with a POST method.
Step 2: Handle requests from SuperPath
Your endpoint must be configured to read an The Event object for the type of event notifications you want to receive. SuperPath sends events to your webhook endpoint as part of a POST request with a JSON payload.
Check event objects
Each event is structured as an event type, dateSent and data elements. Your endpoint must check the event type and parse the payload of each event.
Return a 2xx response
Your endpoint must quickly return a successful status code (2xx) prior to any complex logic that could cause a timeout. For example, you must return a 200 response before updating your system with a users record.
Built-in retries
SuperPath webhooks have built-in retry methods for 3xx, 4xx, or 5xx response status codes. If SuperPath doesn’t quickly receive a 2xx response status code for an event, we mark the event as failed and stop trying to send it to your endpoint. After multiple days, we email you about the misconfigured endpoint, and automatically disable it soon after if you haven’t addressed it.
Step 4: Secure your webhooks (recommended)
Use Webhook Signature Authentication to verify that SuperPath generated a webhook request and that it didn’t come from a server acting like SuperPath.
Updated on: 13/02/2025
Thank you!