Create a Webhook Endpoint
Create a webhook endpoint that can receive data from an external tool using HTTP POST methods. Specify a One-Step Action that determines how the data is consumed by CSM. Each webhook can use basic authentication or no authentication.
Good to Know
- Webhooks require that One-Step Actions include Modifiers to map data in the third-party tool to CSM fields. For guidance on configuring One-Step Actions for webhooks, see Configure One-Step Actions for Webhooks. For Modifier examples, see Webhook Modifier Examples.
- The Base URL for the Cherwell REST API must be set before you can create a functional webhook. See Set the Base URL for the Cherwell REST API.
- To ensure that webhooks run for specific cultures, create a webhook endpoint for each culture. This is useful for using the same One-Step Action for several culture-specific webhooks.
-
Important: If you are working with webhooks after a Protected mApp™ Solution has been applied to your system, note the following:
- If you create or open a Blueprint which has a
Protected mApp Solution
installed, protected webhooks have shield icons
.
- If you select a content-protected webhook and right-click, you cannot delete the webhook.
- If you edit a content-protected webhook, you can change the Authentication Type, add your own username and password for authentication, change the Provider Type, and also change the Endpoint Extension. You cannot delete the associated One-Step Action, Name or Description.
- See Protected mApp Solutions.
- If you create or open a Blueprint which has a
Protected mApp Solution
installed, protected webhooks have shield icons
To create a webhook endpoint: