oncall_handoff_notification_rules

Creates, updates, deletes, gets or lists an oncall_handoff_notification_rules resource.

Overview

Name	oncall_handoff_notification_rules
Type	Resource
Id	pagerduty.users.oncall_handoff_notification_rules

Fields

The following fields are returned by SELECT queries:

get_user_handoff_notifiaction_rule

The user's handoff notification rule requested.

Name	Datatype	Description
id	string
contact_method	object
handoff_type	string	The type of handoff being created. (default: both)
notify_advance_in_minutes	integer	The delay before firing the rule, in minutes.

get_user_handoff_notification_rules

A list of Handoff Notification Rules.

Name	Datatype	Description
id	string
contact_method	object
handoff_type	string	The type of handoff being created. (default: both)
notify_advance_in_minutes	integer	The delay before firing the rule, in minutes.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_handoff_notifiaction_rule	select	id, oncall_handoff_notification_rule_id	Accept, Content-Type	Get details about a User's Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users.read
get_user_handoff_notification_rules	select	id	Accept, Content-Type	List Handoff 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. For more information see the API Concepts Document Scoped OAuth requires: users.read
create_user_handoff_notification_rule	insert	id, data__oncall_handoff_notification_rule	Accept, Content-Type	Create a new Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users.write
delete_user_handoff_notification_rule	delete	id, oncall_handoff_notification_rule_id	Accept, Content-Type	Remove a User's Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users.write
_get_user_handoff_notification_rules	exec	id	Accept, Content-Type	List Handoff 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. For more information see the API Concepts Document Scoped OAuth requires: users.read
_get_user_handoff_notifiaction_rule	exec	id, oncall_handoff_notification_rule_id	Accept, Content-Type	Get details about a User's Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users.read
update_user_handoff_notification	exec	id, oncall_handoff_notification_rule_id, oncall_handoff_notification_rule	Accept, Content-Type	Update a User's Handoff Notification Rule. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. 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
id	string	The ID of the resource.
oncall_handoff_notification_rule_id	string	The oncall handoff notification rule ID on the user.
Accept	string	The Accept header is used as a versioning header.
Content-Type	string

SELECT examples

get_user_handoff_notifiaction_rule

Get details about a User's Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the API Concepts Document

Scoped OAuth requires: users.read

SELECT
id,
contact_method,
handoff_type,
notify_advance_in_minutes
FROM pagerduty.users.oncall_handoff_notification_rules
WHERE id = '{{ id }}' -- required
AND oncall_handoff_notification_rule_id = '{{ oncall_handoff_notification_rule_id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

get_user_handoff_notification_rules

List Handoff 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.
For more information see the API Concepts Document

Scoped OAuth requires: users.read

SELECT
id,
contact_method,
handoff_type,
notify_advance_in_minutes
FROM pagerduty.users.oncall_handoff_notification_rules
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

INSERT examples

create_user_handoff_notification_rule

Create a new Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the API Concepts Document

Scoped OAuth requires: users.write

INSERT INTO pagerduty.users.oncall_handoff_notification_rules (
data__oncall_handoff_notification_rule,
id,
Accept,
Content-Type
)
SELECT 
'{{ oncall_handoff_notification_rule }}' /* required */,
'{{ id }}',
'{{ Accept }}',
'{{ Content-Type }}'
RETURNING
oncall_handoff_notification_rule
;

Manifest

# Description fields are for documentation purposes
- name: oncall_handoff_notification_rules
  props:
    - name: id
      value: string
      description: Required parameter for the oncall_handoff_notification_rules resource.
    - name: oncall_handoff_notification_rule
      value: object
      description: |
        A rule for contacting the user for Handoff Notifications.
    - name: Accept
      value: string
      description: The `Accept` header is used as a versioning header.
    - name: Content-Type
      value: string

DELETE examples

delete_user_handoff_notification_rule

Remove a User's Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the API Concepts Document

Scoped OAuth requires: users.write

DELETE FROM pagerduty.users.oncall_handoff_notification_rules
WHERE id = '{{ id }}' --required
AND oncall_handoff_notification_rule_id = '{{ oncall_handoff_notification_rule_id }}' --required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

Lifecycle Methods

_get_user_handoff_notification_rules

List Handoff 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.
For more information see the API Concepts Document

Scoped OAuth requires: users.read

EXEC pagerduty.users.oncall_handoff_notification_rules._get_user_handoff_notification_rules 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}'
;

_get_user_handoff_notifiaction_rule

Get details about a User's Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the API Concepts Document

Scoped OAuth requires: users.read

EXEC pagerduty.users.oncall_handoff_notification_rules._get_user_handoff_notifiaction_rule 
@id='{{ id }}' --required, 
@oncall_handoff_notification_rule_id='{{ oncall_handoff_notification_rule_id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}'
;

update_user_handoff_notification

Update a User's Handoff Notification Rule.
Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.
For more information see the API Concepts Document

Scoped OAuth requires: users.write

EXEC pagerduty.users.oncall_handoff_notification_rules.update_user_handoff_notification 
@id='{{ id }}' --required, 
@oncall_handoff_notification_rule_id='{{ oncall_handoff_notification_rule_id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}' 
@@json=
'{
"oncall_handoff_notification_rule": "{{ oncall_handoff_notification_rule }}"
}'
;