Send change events to the PagerDuty Events API

Change Events API enables you to send informational events about recent changes such as code deploys and system config changes from any system that can make an outbound HTTP connection. These events do not create incidents and do not send notifications; they are shown in context with incidents on the same PagerDuty service.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Create a new change event.

payload*

Fields adding additional context about the location, impact, and character of the PagerDuty event.

routing_key*string

The GUID of one of your Events API V2 integrations. This is the "Integration Key" listed on the Events API V2 integration's detail page.

links?array<>

Links to be shown on the alert and/or corresponding incident.

images?array<>

Images to be displayed on the alert and/or corresponding incident.

Response Body

`application/json`

curl -X POST "https://example.com/change/enqueue" \  -H "Content-Type: application/json" \  -d '{    "routing_key": "737ea619db564d41bd9824063e1f6b08",    "payload": {      "summary": "Build Success: Increase snapshot create timeout to 30 seconds",      "timestamp": "2015-07-17T08:42:58.315+0000",      "source": "prod-build-agent-i-0b148d1040d565540",      "custom_details": {        "build_state": "passed",        "build_number": "220",        "run_time": "1236s"      }    },    "links": [      {        "href": "https://buildpipeline.com/pagerduty/deployment/builds/220",        "text": "View in Build Pipeline"      }    ],    "images": [      {        "src": "https://chart.googleapis.com/chart?chs=600x400&chd=t:6,2,9,5,2,5,7,4,8,2,1&cht=lc&chds=a&chxt=y&chm=D,0033FF,0,0,5,1",        "href": "https://google.com",        "alt": "An example link with an image"      }    ]  }'

{  "status": "success",  "message": "Event processed",  "dedup_key": "srv01/HTTP"}

Send change events to the PagerDuty Events API

Request Body

Response Body

202application/json

400

429

5XXapplication/json

`application/json`

`application/json`