Cherwell Integration Guide

PagerDuty + Cherwell Integration Benefits

  • Trigger, acknowledge and resolve incidents between Cherwell and PagerDuty.
  • Priorities are automatically synced between PagerDuty and Cherwell.
  • Enables highly customizable workflows and logic.

How it Works

  • As a helpdesk system, incidents are often manually created in Cherwell, but it is possible to configure tools which send emails for automated incidents. Events from Cherwell will trigger a new incident on the corresponding PagerDuty service, or group as alerts into an existing incident.
  • Acknowledging and resolving incidents in PagerDuty will send acknowledge and resolve events to Cherwell.
  • Acknowledging and resolving incidents in Cherwell will send acknowledge and resolve events to PagerDuty.

Requirements

  • In order to configure this integration, you will need Cherwell Administrator Access, Cherwell Service Management Access, and Cherwell enabled on your PagerDuty account.
  • PagerDuty integrations require an Admin base role for account authorization. If you do not have this role, please reach out to an Admin or Account Owner within your organization to configure the integration.
  • A Cherwell system of 9.4 or later is required.

Integration Walkthrough

In PagerDuty

1. Create a REST API Token and keep the Token to be inserted into the Cherwell Configuration. Do this by going to select API Access from the Configuration drop down menu. Then click and the green Create New API Key Button.

2. Keep this key in a safe place for later use. You can now proceed to the In Cherwell section below.

In Cherwell

1. In your Windows environment, access Cherwell Administrator and download the Cherwell-PagerDuty.mApp file.

2. Open Cherwell Administrator and select mApps under Categories, and then click Apply a mApp under Pick a task….

3. Select the Cherwell-PagerDuty.mApp file.

4. Follow through the prompts:

a. Add your Integration Key (generated in the In PagerDuty section above) when prompted.
b. When asked to specify the PagerDuty Base URL, enter http://app.pagerduty.com.

5. After applying the mApp file, open up the Security Settings under Common Tasks and go to Edit REST API client settings where you can retrieve a ClientID that will allow PagerDuty to communicate with Cherwell.

6. To create a new entry, click the green ⊕ button and enter a Name. Copy the Client Key and keep it in a safe place for later use.

7. Create a PagerDuty User within Cherwell. This user will be used by PagerDuty to create and update incidents within Cherwell.

In PagerDuty (Cont.)

1. Go to Configuration and select Services.

2. Add Cherwell as an extension to the service(s) you would like to integrate with.

3. Provide the Cherwell URL, username, password, and Client Key when prompted in Cherwell Authentication.

4. Select the Services that you want PagerDuty and Cherwell to sync.

5. You should now be able to trigger an incident in PagerDuty and open it in Cherwell. If this is unsuccessful, please go back and verify that you’ve input your PagerDuty Integration Key and Cherwell credentials correctly.

FAQ

How do triggered and acknowledged states translate to Cherwell?

A triggered state in Cherwell is New, and an acknowledged event is In Progress. Like PagerDuty, an incident that has been taken care of is classified as being in a Resolved state.