response_plays

Overview

Name	response_plays
Type	Resource
Id	pagerduty.response_plays.response_plays

Fields

Name	Datatype	Description
id	string
name	string	The name of the response play.
description	string	The description of the response play.
_type	string	The type of object being created.
conference_number	string	The telephone number that will be set as the conference number for any incident on which this response play is run.
conference_type	string	This field has three possible values and indicates how the response play was created. - none : The response play had no conference_number or conference_url set at time of creation. - manual : The response play had one or both of conference_number and conference_url set at time of creation. - zoom : Customers with the Zoom-Integration Entitelment can use this value to dynamicly configure conference number and url for zoom
conference_url	string	The URL that will be set as the conference URL for any incident on which this response play is run.
html_url	string	a URL at which the entity is uniquely displayed in the Web app
responders	array	An array containing the users and/or escalation policies to be requested as responders to any incident on which this response play is run.
responders_message	string	The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
runnability	string	String representing how this response play is allowed to be run. Valid options are: - services: This response play cannot be manually run by any users. It will run automatically for new incidents triggered on any services that are configured with this response play. - teams: This response play can be run manually on an incident only by members of its configured team. This option can only be selected when the team property for this response play is not empty. - responders: This response play can be run manually on an incident by any responders in this account.
self	string	the API show URL at which the object is accessible
subscribers	array	An array containing the users and/or teams to be added as subscribers to any incident on which this response play is run.
subscribers_message	string	The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
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.
team	``
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

Name	Accessible by	Required Params	Description
get_response_play	SELECT	id	Get details about an existing Response Play. Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle. For more information see the API Concepts Document When using a Global API token, the From header is required. Scoped OAuth requires: response_plays.read
list_response_plays	SELECT		List all of the existing Response Plays. Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle. For more information see the API Concepts Document When using a Global API token, the From header is required. Scoped OAuth requires: response_plays.read
create_response_play	INSERT	From, data__response_play	Creates a new Response Plays. Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle. For more information see the API Concepts Document Scoped OAuth requires: response_plays.write
delete_response_play	DELETE	From, id	Delete an existing Response Play. Once the Response Play is deleted, the action cannot be undone. WARNING: When the Response Play is deleted, it is also removed from any Services that were using it. Response Plays allow you to create packages of Incident Actions that can be applied to an Incident. For more information see the API Concepts Document Scoped OAuth requires: response_plays.write
_get_response_play	EXEC	id	Get details about an existing Response Play. Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle. For more information see the API Concepts Document When using a Global API token, the From header is required. Scoped OAuth requires: response_plays.read
_list_response_plays	EXEC		List all of the existing Response Plays. Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle. For more information see the API Concepts Document When using a Global API token, the From header is required. Scoped OAuth requires: response_plays.read
run_response_play	EXEC	From, response_play_id, data__incident	Run a specified response play on a given incident. Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle. For more information see the API Concepts Document Scoped OAuth requires: response_plays.write
update_response_play	EXEC	From, id, data__response_play	Updates an existing Response Play. Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle. For more information see the API Concepts Document Scoped OAuth requires: response_plays.write