responder_requests

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

Overview

Name	responder_requests
Type	Resource
Id	pagerduty.incidents.responder_requests

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	id, requester_id, message, responder_request_targets		Send a new responder request for the specified incident. This endpoint requires the account to have access to the [responder requests](https:​//support.pagerduty.com/main/docs/add-responders) feature.<br /><br />Account Ability Requirement: The account must have the coordinated_responding ability. Returns 402 Payment Required if the ability is missing. You can use the List Abilities API to check account abilities.<br /><br />A user or an escalation policy can be requested. The responder targets will be notified via their high urgency notification rules, until the target user has either accepted or declined the request.<br />Previous responder requests for a given target can be cancelled (preventing them from further notifying or escalating), with the Cancel Responder Requests endpoint.<br /><br />Scoped OAuth requires: incidents.write<br />
cancel	exec	id, requester_id, responder_request_targets		Cancel pending responder requests for the specified incident.<br /><br />This endpoint allows you to cancel responder requests for specified targets that are in a pending state. Only responders who have not yet joined or declined can be cancelled. This endpoint requires the account to have access to the [responder requests](https:​//support.pagerduty.com/main/docs/add-responders) feature.<br /><br />Account Ability Requirement: The account must have the coordinated_responding ability. Returns 402 Payment Required if the ability is missing. You can use the List Abilities API to check account abilities.<br /><br />State Constraints: Only responders in the pending state can be cancelled. Responders who have already joined or declined are not affected (the result will indicate their current state).<br /><br />User vs Escalation Policy Behavior:<br />- Users: Direct cancellation, updates state to user_cancelled, stops notifications<br />- Escalation Policies: Stops the escalation process, updates state of all pending users from that escalation policy to user_cancelled and stops notifications<br /><br />Result Values:<br />- cancelled: Successfully cancelled<br />- joined: User already joined (not cancelled)<br />- declined: User already declined (not cancelled)<br />- not_found: Target not found or not part of any responder request<br /><br />Scoped OAuth requires: incidents.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.

INSERT examples

create

Send a new responder request for the specified incident. This endpoint requires the account to have access to the [responder requests](https:​//support.pagerduty.com/main/docs/add-responders) feature.<br /><br />Account Ability Requirement: The account must have the coordinated_responding ability. Returns 402 Payment Required if the ability is missing. You can use the List Abilities API to check account abilities.<br /><br />A user or an escalation policy can be requested. The responder targets will be notified via their high urgency notification rules, until the target user has either accepted or declined the request.<br />Previous responder requests for a given target can be cancelled (preventing them from further notifying or escalating), with the Cancel Responder Requests endpoint.<br /><br />Scoped OAuth requires: incidents.write<br />

INSERT INTO pagerduty.incidents.responder_requests (
requester_id,
message,
responder_request_targets,
id
)
SELECT 
'{{ requester_id }}' /* required */,
'{{ message }}' /* required */,
'{{ responder_request_targets }}' /* required */,
'{{ id }}'
RETURNING
responder_request
;

Manifest

# Description fields are for documentation purposes
- name: responder_requests
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the responder_requests resource.
  - name: requester_id
    value: "{{ requester_id }}"
    description: |
      The user id of the requester.
  - name: message
    value: "{{ message }}"
    description: |
      The message sent with the responder request.
  - name: responder_request_targets
    value: "{{ responder_request_targets }}"
    description: |
      The array of targets the responder request is sent to.

Lifecycle Methods

cancel

Cancel pending responder requests for the specified incident.<br /><br />This endpoint allows you to cancel responder requests for specified targets that are in a pending state. Only responders who have not yet joined or declined can be cancelled. This endpoint requires the account to have access to the [responder requests](https:​//support.pagerduty.com/main/docs/add-responders) feature.<br /><br />Account Ability Requirement: The account must have the coordinated_responding ability. Returns 402 Payment Required if the ability is missing. You can use the List Abilities API to check account abilities.<br /><br />State Constraints: Only responders in the pending state can be cancelled. Responders who have already joined or declined are not affected (the result will indicate their current state).<br /><br />User vs Escalation Policy Behavior:<br />- Users: Direct cancellation, updates state to user_cancelled, stops notifications<br />- Escalation Policies: Stops the escalation process, updates state of all pending users from that escalation policy to user_cancelled and stops notifications<br /><br />Result Values:<br />- cancelled: Successfully cancelled<br />- joined: User already joined (not cancelled)<br />- declined: User already declined (not cancelled)<br />- not_found: Target not found or not part of any responder request<br /><br />Scoped OAuth requires: incidents.write<br />

EXEC pagerduty.incidents.responder_requests.cancel 
@id='{{ id }}' --required 
@@json=
'{
"requester_id": "{{ requester_id }}", 
"responder_request_targets": "{{ responder_request_targets }}"
}'
;