Docs
WebsiteLoginFree Trial
  • Getting Started
    • OnCall Users
    • Team Admins
    • Account Admins
  • Architecture Guide
  • Common UI Design Patterns
  • Alerts
  • Teams
  • Schedules
  • Escalation Policies
  • Integrations
  • Broadcasts
  • Users
  • Notifications
  • Reports
  • Billing
  • Accounts
  • Stakeholders
  • Maintenance Windows
  • Routers
  • Notification Rules
  • Single Sign On (SSO)
  • Integration Guides
    • Introduction
    • 66uptime
    • Apex Ping
    • AppDynamics
    • Auvik
    • AWS CloudWatch
    • Azure Monitor
    • Cloudflare
    • Cronitor
    • Datadog
    • Dead Man's Snitch
    • Echoes HQ
    • ElastAlert
    • Email
    • Form
    • Freshdesk
    • Freshservice
    • Google Hangouts Chat
    • Grafana
    • Healthchecks.io
    • HetrixTools
    • Honeybadger
    • Hydrozen
    • Jira Server
    • JotForm
    • Kapacitor
    • LogicMonitor
    • Mattermost
      • Outgoing Webhook
      • Post to Channel
    • Meta Workplace
    • Microsoft Teams
    • New Relic
    • Outgoing Webhook
    • Pingdom
    • Prometheus
    • PRTG Network Monitor
    • Pulsetic
    • Sentry
    • ServerGuard24
    • Site24x7
    • Slack
      • Notifications
      • Outgoing Webhook
      • Post to Channel
    • SolarWinds
    • Stackdriver
    • StatusCake
    • Twilio
      • Incoming SMS
      • Live Call Routing
    • Typeform
    • Uptime
    • Uptime Kuma
    • UptimeRobot
    • Webhook
    • Zendesk
  • API
    • Introduction
    • Authentication
    • Errors
    • Pagination and Filters
    • Common Model Attributes
    • Account Users
    • Alerts
    • Broadcasts
    • Comments
    • Escalation Policies
    • Events
    • Integrations
    • Logs
    • Maintenance Windows
    • Notification Rules
    • Routers
    • Schedules
    • Teams
    • Users
  • Command Line Interface (CLI)
    • PagerTree CLI: Command Line Interface
Powered by GitBook
On this page
  • The Notification Rule Object
  • Create a Notification Rule
  • Retrieve a Notification Rule
  • Update a Notification Rule
  • Delete a Notification Rule
  • List all Notification Rules

Was this helpful?

  1. API

Notification Rules

PreviousMaintenance WindowsNextRouters

Last updated 2 years ago

Was this helpful?

  • are simple YAML configurations that dictate how PagerTree notifies regarding .

  • Notification Rules must be assigned to the Account User object.

The Notification Rule Object

Property
Type
Description

name

string

The name of the notification rule.

enabled

boolean

Boolean indicating if this notification rule is currently enabled. If false, it will just notify users via their default notification channels.

rules

string

Create a Notification Rule

POST https://api.pagertree.com/api/v4/notification_rules

Allowed Parameters

def notification_rule_params
  params.permit(
    :name,
    :enabled,
    :rules
  )
end

Required Parameters

  • name

Retrieve a Notification Rule

GET https://api.pagertree.com/api/v4/notification_rules/:id

Update a Notification Rule

PUT https://api.pagertree.com/api/v4/notification_rules/:id

Delete a Notification Rule

DELETE https://api.pagertree.com/api/v4/notification_rules/:id

List all Notification Rules

GET https://api.pagertree.com/api/v4/notification_rules

YAML definition of the notification rule. See n.

Notification Rules
Account Users
Alerts
notification rules documentatio