Webhooks

Synap 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.

In order to set up Webhooks, you will need:

1. A Synap Pro account or higher

2. A URL endpoint that can be used to receive the webhooks, or a no-code tool such as Zapier that supports custom webhook actions

Please speak to your account manager if you do not have all of these and we should be able to assist.

To get to your Webhook Settings go to Portal Settings > Data Management > Webhooks

Go to Settings > Data Management and then select the Webhooks tab to find the interface and begin setting up your webhooks

After selecting 'Add webhook' you'll be able to specify the event you want the webhook to be triggered by as well as the URL that you would like the events data to be sent to. You can enable basic authentication should you wish to make your endpoint more secure.

You can create one target URL per event type, or you can assign multiple events to the same target URL. Each webhook comes with a meta.eventName field which can be used to reliably determine what 'type' of event has been received.

Select the even you want to use and the target URL of where you'd like the data to be sent.

The Webhooks we have available are:

Name	Description	Event Name
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. For attempts that require marking this will fire when the attempt is finalised. For auto marked auto released attempts this will fire when the attempt shows as released	attempt.completed
Attempt Override created	Sent when an attempts results are overridden, this included reverting them if they have previously been overridden	attemptOverride.created
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. For attempts that require marking this will fire when the attempt is finalised. For auto marked auto released attempts this will fire when the attempt shows as released	exam.completed
Exam Results Released	Sent when an exam attempts results are relesased to the user	exam.released
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
Invite Sent	Sent when an invite email is sent	invite.sent

If there is an event you were looking to subscribe to that is not listed here, please let us know and we should be able to add it.