Before creating an integration using Integration Hub, we recommend reading through the following articles to get started.
Creating a PagerDuty Integration
PagerDuty is an Incident Tracking and Management platform and the Cyara integration with PagerDuty allows you to track Cyara Test Case and Campaign failures as incidence tickets for further investigation.
To build an integration with PagerDuty, follow the steps below.
- Login to your Cyara Portal.
- Click on Tools > Integrations. (If this menu does not appear in the Tools menu, confirm that the user account you're currently logged into is provisioned to use the Integration Hub).
- Click the New Integration button.
- Select PagerDuty from the Type dropdown menu.
- Enter a Name and a Description for the integration.
- In the PagerDuty Details section, enter the API Url and Incident Portal Url that are exposed by your PagerDuty deployment. (In the example below make sure you replace "Instance" with the instance name of your PagerDuty endpoint, as well as including the {id} tag in the Url in the following format to include the Incidence Ticket reference).
https://instance.pagerduty.com/incidents/{id}
Enter the authentication details for the API Requests that Cyara will send to PagerDuty. Enter the email address of a valid PagerDuty user on the account associated with the supplied API user token from your PagerDuty login. - In the Field Mapping section, select the New PagerDuty Field to add a pre-formatted field mapping for a set PagerDuty field. Or if you click on New Custom Field you can design your own field mapping by entering a Key Value Pair.
- When you click the New Custom Field button to create a new field that is customizable, you will be prompted for the following information.
- Field Name - The property name to send to PagerDuty. For a complete list of available property names consult the PagerDuty API Documentation here : https://api-reference.pagerduty.com/#!/Incidents/post_incidents
- Display Label - The display name for this field, shown when a user creates an incident.
- Type - The Field type. A Choice for multiple fixed values. A single or multiple line text input, or a Lookup for values that are built using an API call.
- Field Value - Enter either a Constant, a Choice formatted as a comma separated list where the first is value is the default or to use a Variable. For more information on Field Values set as Variables, see the Incidence Field Variables table below.
- The final checkboxes allow you to configure field properties such as Required, Read-Only and Overridable.
- Click Add Field to add the new field to the Field Selection table.
- When you click the New Custom Field button to create a new field that is customizable, you will be prompted for the following information.
- Click Save Details to save your changes, and Enable the integration using the toggle in the top right corner of the integration editing screen.
Navigation Backlink
By using the $Url field variable in the table below, you can create a link to the Cyara Test Case from your PagerDuty incident ticket. This is useful to allow for quick navigation directly from PagerDuty back to Cyara for troubleshooting. By default Cyara will automatically create a link from the Test Case to your PagerDuty deployment for any raised incidents.
Incidence Field Variables
The following table shows possible template values of fields to be pushed to ServiceNow. A template can contain one or more replacement variables from the table below:
Variable |
Description |
---|---|
$CampaignName | Campaign Name |
$DetailedResult | Detailed Result |
$Result | Test Result |
$ResultCategory | Test Result Category |
$StepDescription | Failed Step Description |
$StepNo | Failed Step No |
$TestCaseDescription | Test Case Description |
$TestCaseName | Test Case Name |
$TestCaseNotes | Test Case Notes |
$Url | The Url to the Portal Detailed Result page |
$Username | The Username creating the Incident |
Comments
0 comments
Please sign in to leave a comment.