status_update_subscribers

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

Overview

Name	status_update_subscribers
Type	Resource
Id	pagerduty.incidents.status_update_subscribers

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
subscriber_id	string	The ID of the entity being subscribed
has_indirect_subscription	boolean	If this subcriber has an indirect subscription to this incident via another object
subscribed_via	array
subscriber_type	string	The type of the entity being subscribed (user, team)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	id		Retrieve a list of Notification Subscribers on the Incident.<br /><br /><!-- theme: warning --><br />> Users must be added through POST /incident/&#123;id&#125;/status_updates/subscribers to be returned from this endpoint.<br />Scoped OAuth requires: subscribers.read<br />
create	insert	id, subscribers		Subscribe the given entities to Incident Status Update Notifications.<br /><br />Scoped OAuth requires: subscribers.write<br />
unsubscribe	exec	id, subscribers		Unsubscribes the matching Subscribers from Incident Status Update Notifications.<br /><br />Scoped OAuth requires: subscribers.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.

SELECT examples

list

Retrieve a list of Notification Subscribers on the Incident.<br /><br /><!-- theme: warning --><br />> Users must be added through POST /incident/{id}/status_updates/subscribers to be returned from this endpoint.<br />Scoped OAuth requires: subscribers.read<br />

SELECT
subscriber_id,
has_indirect_subscription,
subscribed_via,
subscriber_type
FROM pagerduty.incidents.status_update_subscribers
WHERE id = '{{ id }}' -- required
;

INSERT examples

create

Subscribe the given entities to Incident Status Update Notifications.<br /><br />Scoped OAuth requires: subscribers.write<br />

INSERT INTO pagerduty.incidents.status_update_subscribers (
subscribers,
id
)
SELECT 
'{{ subscribers }}' /* required */,
'{{ id }}'
RETURNING
subscriptions
;

Manifest

# Description fields are for documentation purposes
- name: status_update_subscribers
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the status_update_subscribers resource.
  - name: subscribers
    value:
      - subscriber_id: "{{ subscriber_id }}"
        subscriber_type: "{{ subscriber_type }}"

Lifecycle Methods

unsubscribe

Unsubscribes the matching Subscribers from Incident Status Update Notifications.<br /><br />Scoped OAuth requires: subscribers.write<br />

EXEC pagerduty.incidents.status_update_subscribers.unsubscribe 
@id='{{ id }}' --required 
@@json=
'{
"subscribers": "{{ subscribers }}"
}'
;