PagerTree Knowledge Base

Everything you need to know about PagerTree including quick start guides, videos, and API documentation.

pagertree-alert.curl
curl https://api.pagertree.com/api/v4/alerts
-H "Accept: application/json"
-H "Authorization: Bearer abc123"

Introduction

Getting started

Getting Started

5 minute quick start guide to get you up and running.

Architecture Guide

Learn how the big picture works and objects are related.

Documentation

In depth documentation about each object in PagerTree

API reference

Use our REST API to connect your custom scripts and applications.


Quick Start

In this quick start guide, we’ll cover the basic setup of your PagerTree account, with the goal of getting you setup in the shortest amount of time. The basics will include:

Quick Start Video

Key Terms

PagerTree consists of several major objects:

  • Users - Represent real people. They go on-call and receive notifications (push, email, sms, voice, etc.).
  • Teams - Logically group together Users, Schedules, and Escalation Policies.
  • Schedules - Determine who is on-call at any given moment.
  • Escalation Policies - Define on-call layers and timeouts.
  • Alerts - Represent actionable issues that need user interaction.
  • Integrations - Connectors to third-party tools.

On-Call Schedule

Each Team has an on-call schedule and escalation policy.

Team On-Call Schedule and Escalation Policy

ItemDescription
On-Call Schedule (Top Left)Team's on-call schedule. Team admins can schedule users to be on-call for specific times and dates. Colors represent the escalation layer the event is tied to.
Escalation Policy (Top Right)Team's escalation policy. Determines how alert assigned to this team move through the current on-call schedule escalation layers.
Current On-Call Roster (Bottom)Show which user(s) are currently on-call for any given escalation layer.

Alert Escalation Process

Alert Escalation Process

  1. Your monitoring tools send PagerTree data via integrations.
  2. Integration transforms data into an alert and assigns it to a team.
  3. PagerTree opens the alert and determines who is on-call for the team to begin notifying on-call users of the alert. The Primary On-Call User (Layer 1 is notified). PagerTree waits up to 5 minutes for a response.
  4. If the Primary On-Call User does not acknowledge the alert within the time limit, the alert is escalated. Backup On-Call User (layer 2) is notified.
  5. If the Backup On-Call User acknowledges the alert within the time limit, the alert state is acknowledged, otherwise it is dropped.

Users

User Preferences

Each user has their own preferences. It is up to the user to elect how they want to be notified. This can be done on the My Settings page.

User General Settings

Inviting Users

Users can be added to your account.

  1. Navigate to the Users page.
  2. Click the New User button in the top right corner. Create User Button
  3. Follow the instructions on the New User form:
    • Name - Full Name (Required)
    • Email - Work Email (Required)
    • Roles - Roles this user should have in this PagerTree account.
    • Team - Team this user should be a member of. Create User Form
  4. Click Create button.

If successful, you should now be directed to the newly created user page. A notice at the top of the page will inform you either:

  • Created - The user was successfully created
  • Invited - The user was successfully invited (this user is already part of another PagerTree account).

In each case, the created or invited user will receive an email with directions on how to login.

Create User Invite Email

Connect Your Tools

Create an Integration

  1. Navigate to the Integrations page.
  2. Click the New Integration button in the top right corner. Create Integration Button
  3. Click the integration logo of the tool you are trying to integrate. If you do not see your tool select the email or webhook integration. Create Integration Logo
  4. Follow the instructions on the New Integration form:
    • Name - A memorable name for this integration (Required).
    • Urgency - An appropriate urgency for alerts coming through this integration (Required).
    • Destination - The team alerts should be assigned to for alerts created by this integration (Required). Create Integration Form
  5. Click Create.

If successful, you should now be directed to the newly created integration page. Create Integration

As the last steps you will need to:

  1. Copy the endpoint
  2. Follow the integration guide