Background
By means of a Webhook, assessmentQ can provide external platforms with real-time information.
assessmentQ offers the following Webhooks:
- Session finished
- Assignment results published
When you set up a subscription to (one of) these Webhooks, assessmentQ immediately delivers a message to the external platform when the expected event has occurred, for example when a new session has been finished or when new results are available for an assignment.
As an administrator, you can subscribe to the assessmentQ Webhooks via the Integrations module.
Note: Subscribing to the assessmentQ Webhooks is also supported via the assessmentQ API.
Subscribing to a Webhook
Proceed as follows to subscribe to a Webhook:
- Open the Integrations module in Settings.
Result: The Webhook subscriptions overview is shown. - Click the Add button in the top right corner.
Result: The Add Webhook subscription popup is shown. - Enter a name for your subscription.
Note: In case you subscribe to the Assignment results published Webhook, the name of the subscription will be shown in the Assignment reports module when you select the option Send results.
- Select the event you want to subscribe to.
- Enter the URL to which the data will be sent when the Webhook is triggered.
- Click Save.
Result: The Webhook subscription overview is updated. If you subscribed to the Session finished Webhook, a message will be sent as soon as a participant clicks the Finish button in a session. If you subscribed to the Assignment results published Webhook, a message will be sent as soon as an analyst clicks Send results for an assignment in the Assignment Reports module.