Send an event to PagerDuty

Your monitoring tools should send PagerDuty a trigger event to report a new problem, or update an ongoing problem, depending on the event type.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Trigger or update an alert.

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.

event_action*unknown

The type of event. Can be trigger, acknowledge or resolve.

Value in

"trigger"
"acknowledge"
"resolve"

dedup_key?string

Identifies the alert to trigger, acknowledge, or resolve. Required unless the event_type is trigger.

client?string

The name of the monitoring client that is triggering this event. (This field is only used for trigger events.)

client_url?string

The URL of the monitoring client that is triggering this event. (This field is only used for trigger events.)

Formaturl

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/enqueue" \  -H "Content-Type: application/json" \  -d '{    "payload": {      "summary": "DISK at 99% on machine prod-datapipe03.example.com",      "timestamp": "2015-07-17T08:42:58.315+0000",      "severity": "critical",      "source": "prod-datapipe03.example.com",      "component": "mysql",      "group": "prod-datapipe",      "class": "disk",      "custom_details": {        "free space": "1%",        "ping time": "1500ms",        "load avg": 0.75      }    },    "routing_key": "e93facc04764012d7bfb002500d5d1a6",    "dedup_key": "srv01/mysql",    "event_action": "trigger",    "client": "Sample Monitoring Service",    "client_url": "https://monitoring.service.com",    "links": [      {        "href": "http://pagerduty.example.com",        "text": "An example link."      }    ],    "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 an event to PagerDuty

Request Body

Response Body

202application/json

400

429

5XXapplication/json

`application/json`

`application/json`