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 Integration Object
  • Create an Integration
  • Retrieve an Integration
  • Update an Integration
  • Delete an Integration
  • List all Integrations
  • Retrieve an Integration Type
  • List all Integration Types

Was this helpful?

  1. API

Integrations

PreviousEventsNextLogs

Last updated 2 years ago

Was this helpful?

  • An connects PagerTree to 3rd party applications.

  • Integrations are Open Source. Adapter source code can be found on .

  • Integrations are responsible for transforming 3rd party webhook data into .

  • If able to successfully transform the 3rd party webhook data into an Alert and determining the webhook was a create action, the integration will send the alert to any of , , or .

The Integration Object

Property
Type
Description

name

string

The name of the integration.

enabled

boolean

Boolean indicating if this integration is currently enabled.

urgency

string

Default urgency for the alerts this integration creates.

integration_type

object

The integration type object of this integration.

options

hash

Options for the integration type.

account_user_ids

string[]

router_ids

string[]

team_ids

string[]

Create an Integration

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

Allowed Parameters

def integration_params
    option_keys = params.to_unsafe_h.keys.select { |key| key.to_s.starts_with?("option_") }.map(&:to_sym)
    params.permit(
      :name,
      :enabled,
      :urgency,
      :integration_type_id,
      *option_keys,
      account_user_ids: [],
      router_ids: [],
      team_ids: []
    )
  end

Required Parameters

  • name

  • urgency

  • at least 1 destination (Account User, Router, or Team)

Example Request

POST https://api.pagertree.com/api/v4/integrations/
{
    "name": "Retails Site Uptime Monitor",
    "integration_type_id": "01GDBEYARHS4W4QM6X370Z5TMB",
    "urgency": "high",
    "team_ids": ["01GDKK569YVD2EB6E9V80VXWY1"]
}

Retrieve an Integration

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

Update an Integration

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

Delete an Integration

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

List all Integrations

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

Retrieve an Integration Type

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

List all Integration Types

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

IDs of this integration routes to by default.

IDs of this integration routes to by default.

IDs of this integration routes to by default.

integration_type_id (see how to get a below)

integration
GitHub
Alerts
Account Users
Routers
Teams
list of Integration Types
Account Users
routers
teams