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 Team Object
  • Create a Team
  • Retrieve a Team
  • Update a Team
  • Delete a Team
  • List all Teams
  • Current On-Call
  • List a Team's Alerts

Was this helpful?

  1. API

Teams

  • Teams represent a group of account users. Every team has one active schedule and one active escalation policy.

The Team Object

Property
Type
Description

name

string

The name of the team

escalation_policy_id

string

schedule_id

string

member_account_user_ids

string[]

admin_account_user_ids

string[]

IDs of the account users that take on the admin role for this team.

drop_notifications

string

none|team_all|team_admins|oncall_rotation|specific_users

handoff_notifications

string

none|team_all|team_admins|oncall_rotation|specific_users

drop_notification_account_user_ids

string[]

If drop_notifications set to specific_users, the account user IDs to send drop notifications to.

handoff_notification_account_user_ids

string[]

If handoff_notifications set to specific_users, the account user IDs to send drop notifications to.

notes

string

Notes to be displayed for this team.

attachments

hash

:filename, :url

Create a Team

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

Allowed Parameters

def team_params
  params.permit(
    :meta,
    :name,
    :notes,
    :drop_notifications,
    :handoff_notifications,
    member_account_user_ids: [],
    admin_account_user_ids: [],
    drop_notification_account_user_ids: [],
    handoff_notification_account_user_ids: []
  )
end

Required Parameters

  • name

  • at least 1 account user as a member role

  • at least 1 account user as an admin role

A default schedule and escalation policy will be created by PagerTree.

Retrieve a Team

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

Update a Team

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

Delete a Team

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

List all Teams

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

Current On-Call

Returns on-call event attendees for now for this team. (Handles repeating events and rotations)

Shortcut for schedule current on-call method.

GET https://api.pagertree.com/api/v4/teams/:id/current_oncall

List a Team's Alerts

Return alerts that have been assigned to this team.

GET https://api.pagertree.com/api/v4/teams/:id/alerts
PreviousSchedulesNextUsers

Last updated 3 months ago

Was this helpful?

The ID of the active for this team.

The ID of the active for this team.

IDs of the take on the member role for this team.

escalation policy
schedule
account users