Skip to main content

​
Overview

The get_change_event tool retrieves detailed information about a specific change event, including its summary, timestamp, associated services, and custom details.
This is a read-only tool that does not modify any data in your PagerDuty account.

​
Parameters

​
change_event_id
string
required
The unique identifier of the change event to retrieve.Example: "CHGEVT123"

​
Response

Returns a detailed change event object.
​
id
string
The unique identifier of the change event
​
type
string
Always returns "change_event"
​
summary
string
A brief text summary of the change event (maximum 1024 characters)
​
timestamp
datetime
The date and time when the change event occurred
​
services
array
An array of references to services associated with this change event
​
integration
object
Reference to the integration that created this change event
​
routing_key
string
The 32-character integration key used for routing the event
​
source
string
The unique location of the affected system. This can be a hostname, FQDN, or any unique identifier.
​
links
array
List of links providing additional context about the change
​
images
array
List of images providing visual context about the change
​
custom_details
object
Additional custom details about the change event. This can contain any key-value pairs relevant to the change.

​
Example Usage

"Show me the details of change event CHGEVT123"

​
Use Cases

  • Incident investigation - Review changes that may have caused an incident
  • Deployment verification - Confirm details of a specific deployment
  • Audit trail - Examine the complete details of a change for compliance
  • Service correlation - See which services were affected by a change
  • Integration tracking - Identify which integration created the change event

​
Response Example

{
  "id": "CHGEVT123",
  "type": "change_event",
  "summary": "Deployed v2.3.1 to production",
  "timestamp": "2024-01-15T14:30:00Z",
  "source": "deployment-pipeline",
  "services": [
    {
      "id": "PSVC123",
      "type": "service_reference",
      "summary": "Production API"
    }
  ],
  "integration": {
    "id": "PINT456",
    "type": "integration_reference",
    "summary": "GitHub Actions"
  },
  "links": [
    {
      "href": "https://github.com/org/repo/releases/tag/v2.3.1",
      "text": "Release Notes"
    }
  ],
  "custom_details": {
    "version": "2.3.1",
    "environment": "production",
    "deployer": "[email protected]"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us