Cancel Incident Responder Request

Cancel responder requests for an incident

PUT/incidents/{id}/responder_requests/cancel

Use it in a workflow

Add a step and choose the PagerDuty connector.
Pick the Cancel Incident Responder Request action (under Incidents).
Fill in the fields below, then reference the result from later steps as {{cancelIncidentResponderRequest.response.data}}.

idstringrequired

The ID of the resource.

Acceptstringrequired

The `Accept` header is used as a versioning header.

Default "application/vnd.pagerduty+json;version=2"

Content-Typestringrequired

One ofapplication/jsonDefault "application/json"

Enter the body as JSON in the step's Body field.

requester_idstringrequired

The user id of the requester.

responder_request_targetsarray<object>required

The array of targets to cancel.

typestringrequired

The type of target (either a user or an escalation policy)

One ofuser_referenceescalation_policy_reference

idstringrequired

The id of the user or escalation policy

json

{
  "requester_id": "string",
  "responder_request_targets": [
    {
      "type": "user_reference",
      "id": "string"
    }
  ]
}

Returns 200 with an object. Read it in later steps with {{cancelIncidentResponderRequest.response.data.<field>}}.

responder_request_targetsarray<object>

The array of targets with their cancellation results.

typestringrequired

The type of target (either a user or an escalation policy)

One ofuser_referenceescalation_policy_reference

idstringrequired

The id of the user or escalation policy

resultstringrequired

The result of the cancellation attempt

One ofcancelledjoineddeclinednot_found

json

{
  "responder_request_targets": [
    {
      "type": "user_reference",
      "id": "string",
      "result": "cancelled"
    }
  ]
}

Need more? See the PagerDuty guide for connection setup and behaviour shared by every action.

Was this page helpful?