Creates a new on-call handoff notification rule for a specific user in PagerDuty. This endpoint allows you to set up automated notifications for when a user is about to start or end their on-call shift. It defines how and when the user should be notified about upcoming handoffs,…
idRequiredstringThe ID of the user for whom to create the handoff notification rule.
oncall__handoff__notification__rule__idstringThe ID of the handoff notification rule. This is typically auto-generated by PagerDuty and should be omitted when creating a new rule.
oncall__handoff__notification__rule__handoff__typeRequiredstringThe type of handoff for which to send notifications. Must be one of: 'oncall' (notify when going on-call), 'offcall' (notify when going off-call), or 'both' (notify for both).
oncall__handoff__notification__rule__contact__methodRequiredobjectThe contact method to use for this notification rule. Must be an object with 'id' and 'type' fields. The 'id' should be a valid contact method ID for this user (obtainable via the retrieve_user_contact_methods_via_id action). The 'type' must be one of: 'email_contact_method', 's…
oncall__handoff__notification__rule__notify__advance__minutesintegerThe number of minutes before the handoff when the notification should be sent. Must be between 0 and 2880 (48 hours). Default is 0 (at the time of handoff).
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.