{"_id":"564e5a9c1560880d008d30de","githubsync":"","__v":19,"category":{"_id":"564e5a9b1560880d008d30dd","pages":["564e5a9c1560880d008d30de","56b217d91bc8490d00701f1b","56c3ccf72d97560d00e23cdc","56c515470fba010d00430759","56c515606889720d0099daf7","56d9e2106fcdd00b0002cc3f"],"project":"564e5930c3553e0d003e53d0","version":"564e5a9b1560880d008d30dc","__v":6,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-19T23:20:17.607Z","from_sync":false,"order":0,"slug":"documentation","title":"Getting Started"},"parentDoc":null,"project":"564e5930c3553e0d003e53d0","user":"564e5788230d7c1700c9073e","version":{"_id":"564e5a9b1560880d008d30dc","project":"564e5930c3553e0d003e53d0","__v":27,"createdAt":"2015-11-19T23:26:19.166Z","releaseDate":"2015-11-19T23:26:19.166Z","categories":["564e5a9b1560880d008d30dd","566318e1f5ca460d00f41896","56631d08cd54d50d005015fa","56631d2a81ad7417006a202c","5668ba19fbd7680d009375f4","5668cb8b10bda80d00797ed9","5668cb9d10bda80d00797eda","56830d8a3f94e00d004e2a7a","56830d9072bb720d0091f594","56830d94cb4d190d0027698e","56830dc44aecbd0d00a464c5","569e90f3c9b43e0d00c4bab1","56a96d338791090d00113bab","56b12d8336d2580d00247877","56c36bf0a869d017002ea55b","56c36bf93d30210d00ea84bb","56c77749b935671700ff0304","56c7ab9e5652c217008e091a","56cb8bdad5c6241d00ef5e61","58aefce02470660f00b54539","58aefd0bebd7370f0078b954","59ca65ca4337830026edf24f","5c33cd9eb47ba20051ac8d64","5c33df728bec1d0063431c34","5c4783ef523219027055513a","5c4f35033400f3010203a999","5d1d0c9f19c3a0003aeb525a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Foundation","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-19T23:20:18.435Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"PagerDuty provides a number of ways to programmatically interact with a PagerDuty account.\n\nWhether you are looking to alter an account's configuration, pipe events from a monitoring tool into PagerDuty, update other systems when actions take place in PagerDuty, or retrieve information about activity on a PagerDuty account, there are APIs that expose this functionality to your code.\n\nThe details of how to interact with any given API are accessible in documentation guides listed in the left column navigation.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"REST API\"\n}\n[/block]\nThe [REST API](doc:rest-api) is used for accessing and manipulating data concerning all of the entities on a PagerDuty account. It is designed around RESTful principles and provides a standard suite of CRUD actions for most entities: create, read, update, and delete.\n\nUsing the [REST API](doc:rest-api), you can do things like:\n- add and configure users on a PagerDuty account, including how they're notified by PagerDuty\n- set up workflows for responding to incidents\n- find out who is on call and when they're being notified\n- display a list of open or recent incidents for a team\n- manually create an incident without an associated monitoring tool\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The REST API should not be used to create incidents originating from monitoring systems or other automated tools - for that, use the [Events API](doc:events-api-v2) instead. [Read more](doc:incident-creation-api) about the synchronous Incident Creation API.\",\n  \"title\": \"Note\"\n}\n[/block]\n\nReady to dive in? Read the [REST API Overview](doc:rest-api) to get started and consult the [API Reference](page:api-reference) for comprehensive details about each endpoint and to try it out right from the documentation.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Events APIs\"\n}\n[/block]\nThe Events APIs, [v2](doc:events-api-v2) and [v1](doc:events-api), are asynchronous APIs for connecting your systems to PagerDuty via various monitoring tools. Through the Events APIs, events — which represent occurrences in the services managed by an account — are sent to PagerDuty to be processed.\n\nIf you're looking to leverage PagerDuty's Event Management features to turn data gathered from monitoring tools into actionable incidents, the Events APIs are the gateway to doing so.\n\nThe [Events API v2 Overview](doc:events-api-v2) and [Events API v1 Overview](doc:events-api) have the basics on what events are and how to send them to PagerDuty.\n\n## Which version of the Events API should I use?\n\nBoth versions of the Events API are 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).\n\nHowever, Events API v2 provides a direct interface to set [PD-CEF fields](https://support.pagerduty.com/docs/pd-cef) in the PagerDuty alerts. This makes it easier to generate rich alert data in PagerDuty for better classification, filtering and operational intelligence.\n\nHence, if you are creating a new or custom integration, we strongly recommend using the Events API v2. If you are using a custom monitoring tool, library, or script that has not yet been updated to v2, you can still use the [Events API v1](https://v2.developer.pagerduty.com/docs/events-api). There are no plans as of 2019 to deprecate the Events API v1 in the foreseeable future.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Webhooks\"\n}\n[/block]\nVia [Webhooks](doc:webhooks-overview), PagerDuty will send information about actions taking place within PagerDuty to any software of your choice that can accept an HTTP request.\n\nCheck out the [Webhooks Overview](doc:webhooks-overview) to learn how to parse and interpret webhooks that are sent to your software, as well as the different types of webhooks that your software can receive.","excerpt":"This page will help you get started with PagerDuty. You'll be up and running in a jiffy!","slug":"getting-started","type":"basic","title":"Introduction"}

Introduction

This page will help you get started with PagerDuty. You'll be up and running in a jiffy!

PagerDuty provides a number of ways to programmatically interact with a PagerDuty account. Whether you are looking to alter an account's configuration, pipe events from a monitoring tool into PagerDuty, update other systems when actions take place in PagerDuty, or retrieve information about activity on a PagerDuty account, there are APIs that expose this functionality to your code. The details of how to interact with any given API are accessible in documentation guides listed in the left column navigation. [block:api-header] { "type": "basic", "title": "REST API" } [/block] The [REST API](doc:rest-api) is used for accessing and manipulating data concerning all of the entities on a PagerDuty account. It is designed around RESTful principles and provides a standard suite of CRUD actions for most entities: create, read, update, and delete. Using the [REST API](doc:rest-api), you can do things like: - add and configure users on a PagerDuty account, including how they're notified by PagerDuty - set up workflows for responding to incidents - find out who is on call and when they're being notified - display a list of open or recent incidents for a team - manually create an incident without an associated monitoring tool [block:callout] { "type": "info", "body": "The REST API should not be used to create incidents originating from monitoring systems or other automated tools - for that, use the [Events API](doc:events-api-v2) instead. [Read more](doc:incident-creation-api) about the synchronous Incident Creation API.", "title": "Note" } [/block] Ready to dive in? Read the [REST API Overview](doc:rest-api) to get started and consult the [API Reference](page:api-reference) for comprehensive details about each endpoint and to try it out right from the documentation. [block:api-header] { "type": "basic", "title": "Events APIs" } [/block] The Events APIs, [v2](doc:events-api-v2) and [v1](doc:events-api), are asynchronous APIs for connecting your systems to PagerDuty via various monitoring tools. Through the Events APIs, events — which represent occurrences in the services managed by an account — are sent to PagerDuty to be processed. If you're looking to leverage PagerDuty's Event Management features to turn data gathered from monitoring tools into actionable incidents, the Events APIs are the gateway to doing so. The [Events API v2 Overview](doc:events-api-v2) and [Events API v1 Overview](doc:events-api) have the basics on what events are and how to send them to PagerDuty. ## Which version of the Events API should I use? Both versions of the Events API are 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). However, Events API v2 provides a direct interface to set [PD-CEF fields](https://support.pagerduty.com/docs/pd-cef) in the PagerDuty alerts. This makes it easier to generate rich alert data in PagerDuty for better classification, filtering and operational intelligence. Hence, if you are creating a new or custom integration, we strongly recommend using the Events API v2. If you are using a custom monitoring tool, library, or script that has not yet been updated to v2, you can still use the [Events API v1](https://v2.developer.pagerduty.com/docs/events-api). There are no plans as of 2019 to deprecate the Events API v1 in the foreseeable future. [block:api-header] { "type": "basic", "title": "Webhooks" } [/block] Via [Webhooks](doc:webhooks-overview), PagerDuty will send information about actions taking place within PagerDuty to any software of your choice that can accept an HTTP request. Check out the [Webhooks Overview](doc:webhooks-overview) to learn how to parse and interpret webhooks that are sent to your software, as well as the different types of webhooks that your software can receive.