Synap Academy
Search
K

Webhooks

Pro customers can use Webhooks to capture and respond to key events in real-time.
Synap offers a number of Webhooks, which are sent when certain events take place on the platform, such as a user completing an exam or updating their account.
Note: We do not yet have an administrator interface for creating new Webhook endpoints, but please speak to your account manager and we can set this up for you.
In order to set up Webhooks, you will need:
  1. 1.
    A Synap Pro account or higher
  2. 2.
    A URL endpoint that can be used to receive the webhooks
  3. 3.
    A set of Synap API credentials
Please speak to your account manager if you do not have all of these and we should be able to assist.
The webhooks we have available are:
Name
Description
Code
Attempt Submitted
Sent when a user submits any test or exam attempt on the platform
attempt.submitted
Attempt Completed
Sent when any attempt is 'completed' (including marking) on the platform
attempt.completed
Exam Submitted
Sent when a user submits an exam attempt on the platform
exam.submitted
Exam Completed
Sent when an exam attempt is 'completed' (including marking) on the platform
exam.completed
User Registered
Sent when a new user account is created on the platform
user.registered
User Updated
Sent when a user's account details are updated
user.updated
User Added to Group
Sent when a user is added to a new user group
user.addedToGroup
User Registered for Exam
Sent when a user is registered for an exam
user.registeredForExam
Assignment Completed
Sent when an Assignment is completed on the platform
assignment.completed
Flag Planted
Sent when a Flag is planted on a question
flag.planted
Store Purchase*
Sent when a user makes a purchase in the Synap store.
store.purchase
Store Purchase* The Synap store is a custom feature not available out of the box and is not a on any standard plans If there is an event you were looking to subscribe to that is not listed here, please let us know!