Add a Web Hook

You can add a new web hook to connect a new or additional external system.

To add a web hook

Step 1: Click Administration > Manage Campus > Organization Tools > Web Hooks.

The Web Hooks page is displayed.

Step 2: Click Add.

The Manage Web hook Interface dialog box is displayed.

Step 3: In the Name box, type the name of the web hook.

The name is displayed on the Web Hooks page.

Step 4: In the Url box, type the http:// or https:// URL where the web hook body (refer to Step 8) should be sent when this web hook is executed.

This is a mandatory field.

Step 5: In the Event Type list, enter the event type for which the notification is triggered such as Complete Enrollment, Enrollment Created**, **Subscription Created, Subscription Status Changed, Subscription Updated, and Assignment Complete.

When the event occurs within this organization, the web hook is executed.

Step 6: In the Verb list, enter the HTTP methods such as Get, Post, Update, and Delete.

Step 7: In the Query String, click Manage QueryString, and then enter the query string that the remote server requires.

The Manage QueryString button is disabled, when you are creating a web hook for the first time. The Manage QueryString button is enabled, after you create a web hook and try to edit it later.

Step 8: In the Body box, type the XML, JSON, and other formats that HTTPS request allows.

The body can be built by using the Velocity Template Language (VTL) properties. Click the icon to access the available VTL properties.

The Body box is disabled if you enter Get and is enabled when you enter Post, Update, and Delete in the Verb list. The body content must match the Content Type.

Step 9: In the Content Type box, type the content of the body text.

Step 10: Click Save.

The new web hook is saved.

© NexPort Solutions 2022. All Rights Reserved.