Skip to main content
Skip table of contents


Supported Versions

Please note that using a supported version is mandatory.


Supported Deployment Types

Supported Versions

Cherwell Service Management


8.x (or newer)

Environmental Prerequisites

Confirm the prerequisites of the corresponding integration template before continuing further, as some templates may not require all environmental prerequisites.

How to create an API Key in Cherwell Service Management?

  1. Open the Cherwell Administrator Application.

  2. Click the Security button on the left side and click the Edit REST API Client Settings button.

  3. Now click the File → New button to create a new API Key and configure it as follows:

    • Input a Display Name for your key.

    • Enable the API Access is Enabled option.

How to create a Correlation ID field in Cherwell Service Management?

  1. Open your Cherwell Administrator Application and login with your administrator account.

  2. Click the Create New Blueprint button, located under the Common Tasks pane, on the application's left side.

  3. Double-click the desired Business Object from the list.

  4. Click the Add Field button on the left side of the application.

  5. After accessing the new field properties window, configure the following:

    • Name → Input Correlation ID. Note that the internal name will be automatically populated as CorrelationId; keep the default value.

    • Track Changes to the Field  → Enable this option.

    • Include in Full-Text Search → Enable this option.

    • Length → Input 150 to avoid trimming.

Connected System Configuration

Follow the steps below to add your instance as a connected system.

  1. Log into your ZigiOps instance.

  2. Navigate to Connected Systems → Add New System → Cherwell and configure the following parameters: 

    • URL → Input the URL of your instance. For example,

    • Username → Input your username.

    • Password → Input the password for the above user.

    • API Token → Input the API key that you generated earlier.

    • Proxy Settings → Enables the usage of a proxy server.

  3. Examine the settings and if they are correct, click the Save button to save the system.

Related Templates

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.