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

The user's handoff notification rule requested.

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

list

A list of Handoff Notification Rules.

Name	Datatype	Description
id	string
contact_method	object	(opaque JSON object)
handoff_type	string	The type of handoff being created. (both, oncall, offcall) (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	select	id, oncall_handoff_notification_rule_id		Get details about a User's Handoff Notification Rule.<br />Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.<br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)<br /><br />Scoped OAuth requires: users.read<br />
list	select	id		List Handoff Notification Rules of your PagerDuty User.<br />Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.<br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)<br /><br />Scoped OAuth requires: users.read<br />
create	insert	id, oncall_handoff_notification_rule		Create a new Handoff Notification Rule.<br />Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.<br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)<br /><br />Scoped OAuth requires: users.write<br />
update	update	id, oncall_handoff_notification_rule_id, oncall_handoff_notification_rule		Update a User's Handoff Notification Rule.<br />Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.<br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)<br /><br />Scoped OAuth requires: users.write<br />
delete	delete	id, oncall_handoff_notification_rule_id		Remove a User's Handoff Notification Rule.<br />Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.<br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)<br /><br />Scoped OAuth requires: users.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.
oncall_handoff_notification_rule_id	string	The oncall handoff notification rule ID on the user.

SELECT examples

get

Get details about a User's Handoff Notification Rule.<br />Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.<br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)<br /><br />Scoped OAuth requires: users.read<br />

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
;

list

List Handoff Notification Rules of your PagerDuty User.<br />Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.<br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)<br /><br />Scoped OAuth requires: users.read<br />

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

INSERT examples

create

Create a new Handoff Notification Rule.<br />Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.<br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)<br /><br />Scoped OAuth requires: users.write<br />

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

Manifest

# Description fields are for documentation purposes
- name: oncall_handoff_notification_rules
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the oncall_handoff_notification_rules resource.
  - name: oncall_handoff_notification_rule
    description: |
      A rule for contacting the user for Handoff Notifications.
    value:
      id: "{{ id }}"
      notify_advance_in_minutes: {{ notify_advance_in_minutes }}
      handoff_type: "{{ handoff_type }}"
      contact_method:
        id: "{{ id }}"
        summary: "{{ summary }}"
        type: "{{ type }}"
        self: "{{ self }}"
        html_url: "{{ html_url }}"

UPDATE examples

update

Update a User's Handoff Notification Rule.<br />Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.<br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)<br /><br />Scoped OAuth requires: users.write<br />

UPDATE pagerduty.users.oncall_handoff_notification_rules
SET 
oncall_handoff_notification_rule = '{{ oncall_handoff_notification_rule }}'
WHERE 
id = '{{ id }}' --required
AND oncall_handoff_notification_rule_id = '{{ oncall_handoff_notification_rule_id }}' --required
AND oncall_handoff_notification_rule = '{{ oncall_handoff_notification_rule }}' --required
RETURNING
oncall_handoff_notification_rule;

DELETE examples

delete

Remove a User's Handoff Notification Rule.<br />Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.<br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#users)<br /><br />Scoped OAuth requires: users.write<br />

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