change_events

Creates, updates, deletes, gets or lists a change_events resource.

Overview

Name	change_events
Type	Resource
Id	pagerduty.change_events.change_events

Fields

The following fields are returned by SELECT queries:

get

The Change Event requested.

Name	Datatype	Description
id	string
custom_details	string	Additional details about the change event. (opaque JSON object) (title: Custom Details)
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
images	array
integration	object	(opaque JSON object)
links	array	List of links to include.
routing_key	string	This is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. (title: Routing Key)
self	string (url)	the API show URL at which the object is accessible
services	array	An array containing Service objects that this change event is associated with.
source	string	The unique name of the location where the Change Event occurred.
summary	string	A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
timestamp	string (date-time)	The time at which the emitting tool detected or generated the event.
type	string	A string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.

list

The array of Change Events returned by the query.

Name	Datatype	Description
id	string
custom_details	string	Additional details about the change event. (opaque JSON object) (title: Custom Details)
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
images	array
integration	object	(opaque JSON object)
links	array	List of links to include.
routing_key	string	This is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. (title: Routing Key)
self	string (url)	the API show URL at which the object is accessible
services	array	An array containing Service objects that this change event is associated with.
source	string	The unique name of the location where the Change Event occurred.
summary	string	A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
timestamp	string (date-time)	The time at which the emitting tool detected or generated the event.
type	string	A string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Get details about an existing Change Event.<br /><br />Scoped OAuth requires: change_events.read<br />
list	select		limit, offset, total, team_ids[], integration_ids[], since, until	List all of the existing Change Events.<br /><br />Scoped OAuth requires: change_events.read<br />
create	insert			Sending Change Events is documented as part of the V2 Events API. See [Send Change Event](https:​//developer.pagerduty.com/api-reference/b3A6Mjc0ODI2Ng-send-change-events-to-the-pager-duty-events-api).<br />
update	update	id, change_event		Update an existing Change Event<br /><br />Scoped OAuth requires: change_events.write<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the resource.
integration_ids[]	array	An array of integration IDs. Only results related to these integrations will be returned.
limit	integer	The number of results per page.
offset	integer	Offset to start pagination search results.
since	string (date-time)	The start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.
team_ids[]	array	An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.
total	boolean	By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our [Pagination Docs](https:​//developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.
until	string (date-time)	The end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.

SELECT examples

get

Get details about an existing Change Event.<br /><br />Scoped OAuth requires: change_events.read<br />

SELECT
id,
custom_details,
html_url,
images,
integration,
links,
routing_key,
self,
services,
source,
summary,
timestamp,
type
FROM pagerduty.change_events.change_events
WHERE id = '{{ id }}' -- required
;

list

List all of the existing Change Events.<br /><br />Scoped OAuth requires: change_events.read<br />

SELECT
id,
custom_details,
html_url,
images,
integration,
links,
routing_key,
self,
services,
source,
summary,
timestamp,
type
FROM pagerduty.change_events.change_events
WHERE limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND total = '{{ total }}'
AND team_ids[] = '{{ team_ids[] }}'
AND integration_ids[] = '{{ integration_ids[] }}'
AND since = '{{ since }}'
AND until = '{{ until }}'
;

INSERT examples

create

Sending Change Events is documented as part of the V2 Events API. See [Send Change Event](https:​//developer.pagerduty.com/api-reference/b3A6Mjc0ODI2Ng-send-change-events-to-the-pager-duty-events-api).<br />

INSERT INTO pagerduty.change_events.change_events (

)
SELECT 

;

Manifest

# Description fields are for documentation purposes
- name: change_events
props:

UPDATE examples

update

Update an existing Change Event<br /><br />Scoped OAuth requires: change_events.write<br />

UPDATE pagerduty.change_events.change_events
SET 
change_event = '{{ change_event }}'
WHERE 
id = '{{ id }}' --required
AND change_event = '{{ change_event }}' --required
RETURNING
change_event;