WebHook integration provides Velpic with a way of communicating real-time information to third-party applications using HTTP callbacks.
WebHooks make HTTP POST requests to send data in real-time. This is advantageous over traditional API’s which require frequent polling, a process that can be less efficient.
Using the Velpic platform, you can specify multiple Uniform Resource Identifiers (URI) to send messages after an event occurs. Messages are sent in JSON format.
Velpic current supports posting data after the following:
Lesson Schedule Completed - A message is sent when a Trainee completes a scheduled lesson
Lesson Schedule Changed - When an administrator makes changes to a lesson schedule, a message is sent for each Trainee affected by the change.
Lesson Schedule Created - When an administrator schedules a lesson, a message is sent for each Trainee scheduled for the lesson.
Lesson Schedule Canceled - When an administrator cancels a lesson schedule, a message is sent for each Trainee affected by the change.
User Created - A message is sent when a new user account is created.
User Updated - A message is sent when a user or administrator updates their account details.
User Inactivated - A message is sent when an administrator inactivates a user account.
All Events - A message is sent when any of the previously listed events occur.
For more information on WebHook event payloads, visit the Velpic developer site at developer.velpic.com
Adding a WebHook
To add a WebHook, navigate to the Integrations tab under "Manage".
The options that you see here will differ according to your subscription level, but the one you want is "WebHooks". Click on that.
When you first enter you will not have any existing WebHook. To create your first, enter your URI into the "WebHook URI" field.
Then select the event that you are interested in. If you wish to react to all events, select "All Events". It is ok to create multiple WebHooks linked to the same URI if you wish.
Once you are happy with your selection, click the "Add" button. Your WebHook will be saved and appear below. You can add as many WebHooks as you require.
Removing a WebHook
Once a webhook has been created it will appear in a list below the Add a WebHook box.
To remove your previously created WebHook, simply click the Trash Can button. Your WebHook will be deleted and all future posts to the specified URI, stopped.