status_update_notification_rules

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

Overview

Name	status_update_notification_rules
Type	Resource
Id	pagerduty.users.status_update_notification_rules

Fields

The following fields are returned by SELECT queries:

get_user_status_update_notification_rule

The user's status update notification rule requested.

Name	Datatype	Description
contact_method	object

get_user_status_update_notification_rules

A list of status update notification rules.

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_status_update_notification_rule	select	X-EARLY-ACCESS, id, status_update_notification_rule_id	Accept, Content-Type, include[]	Get details about a user's status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. For more information see the API Concepts Document Scoped OAuth requires: users.read
get_user_status_update_notification_rules	select	id, X-EARLY-ACCESS	Accept, Content-Type, include[]	List status update notification rules of your PagerDuty user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. For more information see the API Concepts Document Scoped OAuth requires: users.read
create_user_status_update_notification_rule	insert	X-EARLY-ACCESS, id, data__status_update_notification_rule	Accept, Content-Type	Create a new status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. For more information see the API Concepts Document Scoped OAuth requires: users.write
delete_user_status_update_notification_rule	delete	X-EARLY-ACCESS, id, status_update_notification_rule_id	Accept, Content-Type	Remove a user's status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. For more information see the API Concepts Document Scoped OAuth requires: users.write
_get_user_status_update_notification_rules	exec	id, X-EARLY-ACCESS	Accept, Content-Type, include[]	List status update notification rules of your PagerDuty user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. For more information see the API Concepts Document Scoped OAuth requires: users.read
_get_user_status_update_notification_rule	exec	X-EARLY-ACCESS, id, status_update_notification_rule_id	Accept, Content-Type, include[]	Get details about a user's status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. For more information see the API Concepts Document Scoped OAuth requires: users.read
update_user_status_update_notification_rule	exec	X-EARLY-ACCESS, id, status_update_notification_rule_id, status_update_notification_rule	Accept, Content-Type	Update a user's status update notification rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. For more information see the API Concepts Document Scoped OAuth requires: users.write

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
X-EARLY-ACCESS	string	This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header and the above value. Do not use this endpoint in production, as it may change!
id	string	The ID of the resource.
status_update_notification_rule_id	string	The status update notification rule ID on the user.
Accept	string	The Accept header is used as a versioning header.
Content-Type	string
include[]	string	Array of additional details to include.

SELECT examples

get_user_status_update_notification_rule

Get details about a user's status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the API Concepts Document

Scoped OAuth requires: users.read

SELECT
contact_method
FROM pagerduty.users.status_update_notification_rules
WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND id = '{{ id }}' -- required
AND status_update_notification_rule_id = '{{ status_update_notification_rule_id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
AND include[] = '{{ include[] }}'
;

get_user_status_update_notification_rules

List status update notification rules of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the API Concepts Document

Scoped OAuth requires: users.read

SELECT
*
FROM pagerduty.users.status_update_notification_rules
WHERE id = '{{ id }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
AND include[] = '{{ include[] }}'
;

INSERT examples

create_user_status_update_notification_rule

Create a new status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the API Concepts Document

Scoped OAuth requires: users.write

INSERT INTO pagerduty.users.status_update_notification_rules (
data__status_update_notification_rule,
X-EARLY-ACCESS,
id,
Accept,
Content-Type
)
SELECT 
'{{ status_update_notification_rule }}' /* required */,
'{{ X-EARLY-ACCESS }}',
'{{ id }}',
'{{ Accept }}',
'{{ Content-Type }}'
RETURNING
status_update_notification_rule
;

Manifest

# Description fields are for documentation purposes
- name: status_update_notification_rules
  props:
    - name: X-EARLY-ACCESS
      value: string
      description: Required parameter for the status_update_notification_rules resource.
    - name: id
      value: string
      description: Required parameter for the status_update_notification_rules resource.
    - name: status_update_notification_rule
      value: object
      description: |
        A rule for contacting the user for Incident Status Updates.
    - name: Accept
      value: string
      description: The `Accept` header is used as a versioning header.
    - name: Content-Type
      value: string

DELETE examples

delete_user_status_update_notification_rule

Remove a user's status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the API Concepts Document

Scoped OAuth requires: users.write

DELETE FROM pagerduty.users.status_update_notification_rules
WHERE X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' --required
AND id = '{{ id }}' --required
AND status_update_notification_rule_id = '{{ status_update_notification_rule_id }}' --required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

Lifecycle Methods

_get_user_status_update_notification_rules

List status update notification rules of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the API Concepts Document

Scoped OAuth requires: users.read

EXEC pagerduty.users.status_update_notification_rules._get_user_status_update_notification_rules 
@id='{{ id }}' --required, 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}', 
@include[]='{{ include[] }}'
;

_get_user_status_update_notification_rule

Get details about a user's status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the API Concepts Document

Scoped OAuth requires: users.read

EXEC pagerduty.users.status_update_notification_rules._get_user_status_update_notification_rule 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, 
@id='{{ id }}' --required, 
@status_update_notification_rule_id='{{ status_update_notification_rule_id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}', 
@include[]='{{ include[] }}'
;

update_user_status_update_notification_rule

Update a user's status update notification rule.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.

For more information see the API Concepts Document

Scoped OAuth requires: users.write

EXEC pagerduty.users.status_update_notification_rules.update_user_status_update_notification_rule 
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required, 
@id='{{ id }}' --required, 
@status_update_notification_rule_id='{{ status_update_notification_rule_id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}' 
@@json=
'{
"status_update_notification_rule": "{{ status_update_notification_rule }}"
}'
;