iPaaS Webhook setup instructions

by Ray Randall
Follow

This article reviews how to use a generic HTTPS listener tool (included in ALL iPaaS tools) to listen to Skilljar Webhooks, and pass Skilljar Data to ANY other application in your business ecosystem. 

Check out this iPaaS (Integration Platform as a Service) list from G2 to see if you and your company already use any of these tools: https://www.g2.com/categories/ipaas

 

Setup Instructions - for any iPaaS tool

1 - Select the ‘Webhook Listener’ option for the integration tool you are using

910f9d8d-e7d2-48d4-ae92-74dd878da900.png


Here is a bigger list of iPaaS tools to check out in case any of them are already in use by your company: https://www.g2.com/categories/ipaas

 

2 - Generate the Webhook URL and save this to input into the Skilljar Webhook Setup API call

21d59539-ca92-441f-8fbe-645d481b58e1.png

7e080376-a7dc-410f-ab2a-45b89a86cd5c.png

57c81498-fe32-42b9-b914-344b63c1339e.png

 

You can copy this to your clipboard to use in the next step to create/activate the webhook in Skilljar.

 

3 - Enable the webhook via API 


This will leverage the Webhook Create API call - You are welcome to use your preferred API tool OR if you don't have a tool available, you can set this up directly from API Page link below by clicking the “Try it Out” button:

 

b9828bad-75e1-465f-98e8-d1c2ae08a8e7.png


When you click this button you will see the following popup, where you will Paste the webhook URL that you copied in Step 2. You will also want to set this webhook to “Active” using the checkbox below the Target URL:

 

4cc9f414-e9e4-4b85-99ef-a29209bac6fd.png


Once you click “Send Request” you will be shown an authentication popup if this is the first time you have called the Skilljar API from the browser session:

 

bd624690-7fc1-45e5-8cf6-7c95b6a611b9.png


You will need to get an API Key from your ORGANIZATION Settings and input this into the USERNAME section of the API page - the password field should be left blank:

 

b3227ed3-c9c5-42d9-8294-665b211810b7.png


After you sign in with this organization API key, the browser will use this same key for all API calls until the browser session ends, so you wont have to enter this every time you try and call a Skilljar API. If you need to change the Key, you can clear your Cache and Cookies, or open up the Skilljar API page in an Incognito Window.

 

4 - Send Sample Request by taking an action as a student on your training site (registering for a course, completing a lesson)


Most tools will start listening for the first webhook when you generate the Target URL so that they can populate any payload data fields which you can then use in other steps of your workflow (name, email, course/domain information, student sign up fields):

4c985246-3bf5-461d-8ec3-3d328feb2124.png

 

Once a test payload has been received, most of tools will auto-populate all of the Output Fields from the Skilljar test Webhook so that you can begin to use them in filters and send the data passed in these outputs to other tools:

90970d00-984d-45fa-ae20-08faa9877071.png


You may need to send a few test webhooks, as Skilljar does send different payloads depending on the webhook type. For example - PURCHASE_FULFILLMENT and QUIZ_COMPLETION Webhook event types have extra payloads that the other webhook events do not include, so if you are looking to leverage these webhooks, you will want to complete a purchase or a quiz when testing this setup in order to generate the proper output fields in your iPaaS tool.

 

It may be required to PASTE a test payload into these tools to be able to generate the different Output variables, and in this case you can use the SAMPLE WEBHOOK EVENT API calls from the Skilljar API documentation to copy and Paste into these tools:

7c9e12ae-4e0b-41d1-b591-896dac855cb4.png


You should only have to copy and paste the RESULTS line from the RAW payload data (as seen above) into the tool (seen below):

f0847a52-b09f-445f-a20e-602e15631376.png


These tools will be able to parse the data and add the Output fields to the list of outputs you can use in future steps:

5876e832-5f1d-4736-8d27-b3a3c28a2ee8.png

 

515be724-0b2e-4cc2-8f38-abb6689abb89.png

 

These can now be used in Step 5 and 6 to pass this data from the iPaaS tool to your other applications.

 

5 - Add Filter Logic if you want to only take actions on Certain Event Types:


The filter below would only continue the workflow if the event_type is a COURSE_COMPLETION webhook trigger:

 

d5478817-3cd9-43b6-8a32-1756ee081925.png

 

66009d9e-37b8-4309-90c6-6a365a6b8c99.png

 

The different triggers that are currently set by Skilljar (and that you can choose to filter by) are found below:

COURSE_COMPLETION
COURSE_ENROLLMENT
DOMAIN_ENROLLMENT
LESSON_COMPLETION
PURCHASE_FULFILLMENT
QUIZ_COMPLETION

 

6 - Send this data to ANY of your other Applications


Your iPaaS tool can now take this data and send it to ANY other tool that can be connected to this iPaaS tool, so there is absolutely no limit to where you can send training data and to what tools you are able to leverage:

 

e83f489b-c3e9-4c04-ac85-750397899322.gif

 

You can be as creative as you want with your training data - feel free to work with your CSM to talk about how you can best leverage this data in your other tools, or for suggestions on other tools that may benefit from access to the training data generated in Skilljar.

Powered by Zendesk