DO NOT DELETE — [template] Events API Integration Guide intro


~~~REMOVE THIS SECTION, ALONG WITH HORIZONTAL LINES, FROM IG BEFORE PUBLISHING~~~

If you delete this template altogether I will come find you and make you re-write it using only one of your pinkies while “I’m a Little Teapot” blasts in the background.

If you leave this blurb in when you publish your integration guide I will also come find you.

When writing a new integration guide for an API-based partner, copy the sample steps below, clone the page titled Integration Guide Template and paste these steps in for ALL new API based integration guides you create. Make sure to delete and replace [ALL RED NOTES MADE IN BRACKETS] to ensure you’ve added all the necessary information. After the “In PagerDuty” steps, add a new heading and ordered list for the steps customers will need to take in the partner app.


PagerDuty + [PARTNER-NAME] Integration Benefits

  • [ERASE THESE NOTES AND LIST AT LEAST THREE BENEFITS OF THE INTEGRATION HERE]
  • [USE THE DATADOG IG AS AN EXAMPLE]
  • [PLEASE MAKE SURE THAT YOU ERASE THESE]

How it Works

  • [DETAIL SPECIFICALLY WHAT HAPPENS BETWEEN PAGERDUTY AND THE INTEGRATION PARTNER]
  • [USE THE SPECIFIC TERMINOLOGY THAT THE PARTNER DOES TO DESCRIBE ACTIONS]
  • [USE THE DATADOG IG  IG AS AN EXAMPLE]

Requirements

  • [ARE THERE ANY REQUIREMENTS THAT THE CUSTOMER NEEDS TO CONSIDER BEFORE INTEGRATING?]
  • [USE THE DATADOG IG AS AN EXAMPLE]

Integration Walkthrough

In PagerDuty

There are two ways that [PARTNER-NAME] can be integrated with PagerDuty: via Global Event Routing or through an integration on a PagerDuty Service.

If you are adding [PARTNER-NAME] to an existing PagerDuty service, please skip to the Integrating with a PagerDuty Service section of this guide.

Integrating With Global Event Routing

Integrating with Global Event Routing enables you to route events to specific services based on the payload of the event from [PARTNER-NAME]. If you would like to learn more, please visit our article on Global Event Routing.

1. From the Configuration menu, select Event Rules.

2. On the Event Rules screen, click on the arrow next to Incoming Event Source to display the Integration key information. Copy your Integration Key. This is the same integration key you will use for any other tool you want to integrate with using event rules. When you have finished setting up the integration in [PARTNER-NAME], you will return to this interface to specify how to route events from [PARTNER-NAME] to services in PagerDuty.

Keep this key in a safe place for later use. You can now proceed to the In [PARTNER-NAME] section below.

Integrating With a PagerDuty Service

Integrating with a PagerDuty service directly can be beneficial if you don’t need to route alerts from [PARTNER-NAME] to different responders based on the event payload. You can still use service-level event rules to perform actions such as suppressing non actionable alerts and adjusting the severity.

1. From the Configuration menu, select Services.

2. If you are adding your integration to an existing service, click the name of the service you want to add the integration to. Then select the Integrations tab and click the New Integration button.

If you are creating a new service for your integration, please read our documentation in section Configuring Services and Integrations and follow the steps outlined in the Create a New Service section, selecting [PARTNER-NAME] as the Integration Type in step 4. Continue with the In [PARTNER-NAME] section (below) once you have finished these steps.

3. Enter an Integration Name in the format `monitoring-tool-service-name` (e.g. [PARTNER-NAME]-Shopping-Cart) and select [PARTNER-NAME] from the Integration Type menu.

4. Click Add Integration button to save your new integration. You will be redirected to the Integrations tab for your service.

5. An Integration Key will be generated on this screen. Keep this key saved in a safe place, as it will be used when you configure the integration with [PARTNER-NAME] in the next section.