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 Broadcast Object
  • Create a Broadcast
  • Retrieve a Broadcast
  • Update a Broadcast
  • Delete a Broadcast
  • List all Broadcasts
  • Comment on a Broadcast
  • List a Broadcast's Comments

Was this helpful?

  1. API

Broadcasts

  • A broadcast can be used to notify specific Account Users and Teams.

The Broadcast Object

Property
Type
Description

title

string

The title of the broadcast.

description

string

The description of the broadcast.

tag_list

string[]

A list of tags.

destination_team_ids

string[]

destination_account_user_ids

string[]

status

string

The current status state of the broadcast. queued|open|closed|errored

response_requested

boolean

response_requested_by

timestamp

The deadline of when the destinations have to respond by.

broadcast_response_options

BroadcastResponseOption[]

:id, :value, :position, :broadcast_responses_count

broadcast_responses

BroadcastResponses[]

:id, :prefix_id, :account_user_id, :broadcast_response_option_id, :channel, :created_at

Create a Broadcast

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

Allowed Parameters

def broadcast_params
  params.permit(
    :title,
    :description,
    :tag_list,
    :response_requested,
    :response_requested_by,
    destination_team_ids: [],
    destination_account_user_ids: [],
    broadcast_response_options_attributes: [
      :value
    ]
  )
end

Required Parameters

  • title

  • at least 1 destination (Team or Account User)

  • if response requested, at least 1 response option

Retrieve a Broadcast

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

Update a Broadcast

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

Delete a Broadcast

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

List all Broadcasts

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

Comment on a Broadcast

POST https://api.pagertree.com/api/v4/broadcasts/:id/comments

Required Parameters

  • body

List a Broadcast's Comments

GET https://api.pagertree.com/api/v4/broadcasts/:id/comments
PreviousAlertsNextComments

Last updated 1 year ago

Was this helpful?

An array of IDs this broadcast should be sent to.

An array of IDs this broadcast should be sent to.

If a from the destinations.

Team
Account User
response was requested