{"__v":19,"_id":"564e5a9c1560880d008d30de","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"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\": \"The 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](https://v2.developer.pagerduty.com/docs/events-api-v2) instead. [Read more](https://v2.developer.pagerduty.com/v2/docs/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\": \"The Events API\"\n}\n[/block]\nThe [Events API](doc:events-api) is an asynchronous API for connecting your systems to PagerDuty via various monitoring tools. Through the [Events API](doc:events-api), 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 API](doc:events-api) is the gateway to doing so.\n\nThe [Events API Overview](doc:events-api) has the basics on what events are and how to send them to PagerDuty, while the [Events API Reference](page:events-api-reference) provides all the finer points of making calls to the Events API.\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.","category":"564e5a9b1560880d008d30dd","createdAt":"2015-11-19T23:20:18.435Z","excerpt":"This page will help you get started with PagerDuty. You'll be up and running in a jiffy!","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","next":{"description":"","pages":[]},"order":0,"parentDoc":null,"project":"564e5930c3553e0d003e53d0","slug":"getting-started","sync_unique":"","title":"Getting Started","type":"basic","updates":[],"user":"564e5788230d7c1700c9073e","version":"564e5a9b1560880d008d30dc","childrenPages":[]}

Getting Started

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": "The 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](https://v2.developer.pagerduty.com/docs/events-api-v2) instead. [Read more](https://v2.developer.pagerduty.com/v2/docs/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": "The Events API" } [/block] The [Events API](doc:events-api) is an asynchronous API for connecting your systems to PagerDuty via various monitoring tools. Through the [Events API](doc:events-api), 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 API](doc:events-api) is the gateway to doing so. The [Events API Overview](doc:events-api) has the basics on what events are and how to send them to PagerDuty, while the [Events API Reference](page:events-api-reference) provides all the finer points of making calls to the Events API. [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.