Webhooks

A webhook enables you to call an external URL to communicate with any third-party application. For example, you can sync information between two different services, such as ServiceDesk Plus Cloud and any third-party service to maintain your assets, purchase requests, or Active Directory.
 

Supported Modules	Role Required
Requests	SDAdmin, SDSiteAdmin, and HelpDeskConfig
Problems, Changes, Projects, Releases, Solutions, Purchase, Contracts, Custom Modules	SDAdmin
Assets	SDAdmin, AssetConfig
CMDB	SDAdmin, SDCMDBAdmin

 

 

Use $ sign to add a substitution variable as part of the webhook URL.

Configure a new webhook

• Provide a unique name and description for the webhook.

• Enter a valid URL to which the webhook request will be sent.

• In the Applies to field, select the required subentity where the webhook must be applied.

  • GET - Allows you to notify any third-party application about data modifications within any module in ServiceDesk Plus Cloud.

  • PUT - Creates and updates specific data in the third-party site.

  • POST - Creates specific data in the third-party site.

  • DELETE - Removes any specified data such as the login credentials of a former employee in Active Directory.

• Select an Endpoint Type: Cloud or Intranet.

  • For Cloud endpoint types, select the required DRE Connection Link Name from the drop-down.

  • The DRE Connection Link Name is optional and can be selected when required.

  • For Intranet endpoint types, select the required Probe and Callback Function from the drop-down.

• Enter the Header Key and Header Value. Type $ in the value field to view and select available variables.

• Enter the Parameter Name and Parameter Value. Type $ in the value field to view and select available variables.

• Click Save.

In the URL, Headers, Parameters, and Message Body, enter $ in the value field to view and select available variables. Use these variables to insert dynamic values into the request. The > icon indicates subvariables. Enter a dot (.) to access subvariables.

Manage Webhooks

After the webhooks are created, they are listed on the list view page where you can perform the following actions:

• Preview - Click a webhook row to expand and preview the webhook. Click Related Workflows to view the execution details of the webhook in the related automations.

• Edit - Use the icon to edit any webhook.
• Enable/Disable - Use the  icon to enable/disable webhooks. You can also use the toggle on the Status column. To enable/disable in bulk, select the webhooks and use the Actions menu on the toolbar.
• Delete - Use the  icon to delete webhooks. To delete webhooks in bulk, select the webhooks and use the Actions menu on the toolbar.
• Search - Use the icon to search through webhooks using criteria. Add the criteria, value and click Enter. You can add multiple search criteria using the icon. After the results are displayed, click on the existing criteria to edit it.
• Decide List View Layout - Click the icon to limit the number of webhooks listed and to define the sort order.