Immersive Webhooks Set Up Guide for Programs

Go to platform settings, as an Organisation Manager you will be able to see the new Webhooks menu item on the sidebar

Click on Add webhook

Fill in the name and URL of the webhook and select events to subscribe to. At this point in time we only support the Program Deployment Participant Completion event.

For the URL please ensure that the technical documentation for setting up an Immersive Webhook compatible server Immersive Webhooks Integration Guide.

Once you are happy click Add webhook

The secret to copy and store in your webhook server will be provided next.

Click I've copied my secret key to close the modal and the webhook will be displayed in a Needs Verification state.

Note that in the Needs Verification state you will not receive any event requests to your webserver until your webhook has been verified. You can verify by clicking the verify button on the webhook card (as seen in the screenshot below)

Clicking the verification button will either lead to a state change from Needs Verification to Active or it will fail and stay in the Needs Verification state. If failed this means that the endpoint url you have provided has not met the correct criteria to allow the reception of webhook requests, please refer back to the technical setup guide if there are any issues.

You can perform the following actions on webhooks

• Edit: Editing the URL of a webhook will mean that the webhook will need to go through the verification flow again. Editing the name of the webhook does not.
• Regenerate secret
  1. Allows you to regenerate the secure secret for use in your web server if you lose the first one, or need to cycle  the secret.
  2. Performing this action without updating your webserver will result in the verification process failing.
• Delete: Delete an existing webhook. They cannot be recovered if this action is performed. You may however, create a new webhook with the same details if the delete occurs erroneously.

Once in an Active state we will send requests to your web server depending on the event subscribed to
 

Retries and Deactivation

If your endpoint returns a non successful response (2xx code), times out, errors, we treat the delivery as failed and retry for a period of time.

We will email the creator of the webhook a warning email once we start receiving non successful responses.

If all retries fail for a given request, the webhook is deactivated and the owner is emailed. Deactivated webhooks receive no further events until they are reactivated and re-verified.