Create a Generic Events API Integration

Follow

If an out-of-the-box integration for the tool you're using doesn't exist yet, you can create an Events API integration for just about anything, so as long as your system can make outbound HTTP calls.

To add a generic integration:

  1. Go to Configuration → Services.

  2. If you are creating a new service for your integration, click Add New Service.

    If you are adding your integration to an existing service, click the name of the service you want to add the integration to, go to the Integrations tab, then click New Integration.

  3. Select Use our API Directly from the Integration Type menu, select whether you would like to use our v1 or v2 Events API, and and enter an Integration Name.

    If you are creating a new service for your integration, under General Settings, enter a Name for your new service. Then, under incident Settings, specify the Escalation Policy, Notification Urgency, and Incident Behavior for your new service.

  4. Click Add Service/Integration and and integration key will be generated. You'll find this key on the Integrations tab. The integration key is a unique service identifier used by the Events API to trigger, acknowledge, and resolve incidents. Use this key within your monitoring tool to send notifications to PagerDuty and create incidents within your service.

Events API v2

Our new Events API allows monitoring partners to directly send events in the PD-CEF format. If you are using custom monitoring you can also leverage this format to take advantage of the new PD-CEF display and workflow features in PagerDuty.

During your setup process you will be prompted to choose Events API v1 or v2 from a drop down menu after selecting Use our API directly from the Integration Type menu.

v1_v2.png

You must have Create alerts and incidents enabled to use our Events API v2. You will find this setting under Incident Behavior at the bottom of your service configuration screen. When an Events API v2 integration type is selected the Create incidents option will be grayed out.

Should I use API v1 or v2?

The Events API v2 is designed to handle machine-generated monitoring and event data, such as infrastructure monitoring (Nagios, SignalFX, Datadog), application performance monitoring (New Relic, AppDynamics), and external site checks (Pingdom, Wormly). PD-CEF events generate alerts in PagerDuty, which can then be grouped together into Incidents within PagerDuty.

For human-generated events, tickets, or incidents, such as those from ServiceNow or JIRA, we suggest using the Events API v2, which enables direct, streamlined creation of PagerDuty incidents.

If you are using a custom monitoring tool, library, or script that has not yet been updated to V2, you should use the Events API v1.

Have more questions? Submit a request

Comments