Set the Base URL for the Cherwell REST API

The base URL for the Cherwell REST API is required for various CSM features, including authentication, Saved Searches, and webhooks. It is automatically populated when you install CSM. If you need to change it, you can set the base URL for the REST API using Cherwell Server Manager.

You can also view, and in rare cases, change settings for webhooks used with Amazon Web Services (AWS) and Slack.

Setting the Base API URL

To set the base API URL:

In Cherwell Server Manager, select the Configure button by Rest API client configuration.
The REST API URL Settings window appears.
Edit the URL.
In CSM Administrator main window, select Security.
Select Edit REST API client settings.
On the REST API Clients menu bar, select File > Set API URL
In the Maximum Webhook Content Length box, set the maximum number, in bytes, of body content that can be added by any webhook endpoint in the system. The default setting is 100,000 bytes; the maximum is 2,147,483,647 bytes.
Note: If the content of any webhook POST exceeds the length, the webhook POST request will fail.
Select OK.

Viewing Amazon Webhook Settings

Webhooks settings used by Amazon Simple Notification Service (SNS) are provided. You should not modify these settings unless changes are required from Amazon Simple Notification Service (SNS).

If you modify settings and need to revert to the provided settings, select Reset Webhooks Defaults.

Setting	Description
Header Message Type	Determines the type of message being sent from AWS (notification; subscription; unsubscribe). Provided value: x-amz-sns-message-type
Subscription Confirmation	Sent in the header by AWS to indicate that the message type is a Subscription Confirmation.
Notification	Sent in the header by AWS to indicate that the message type is a notification.
Header Message ID	Sent by AWS to indicate message uniqueness to determine if messages have already been sent.

View Slack Webhook Settings

Webhooks settings used by Slack are provided. You should not modify these settings unless changes are required from Slack.

If you modify settings and need to revert to the provided settings, select Reset Webhooks Defaults.

Setting	Description
Signature Header Key	The name of a key sent in the header by Slack. The Slack signature computes the hash that verifies the message's authenticity.
Timestamp Header Key	The name of a key sent in the header by Slack. The timestamp is used to verify the message's authenticity.
Version	The version of the Slack API.
Replay Attack Timeout in Minutes	The number of minutes that elapse between a message being sent from Slack and being processed by CSM. This prevents an attacker from capturing a valid message, altering the contents, and then sending it later.