Link Search Menu Expand Document

Webhook Integration Guide

Logo Company Estimated Time Functionality Vendor Docs
--- 10 minutes One-Way ---

Webhook Integration

Webhooks are user defined HTTP callbacks. They are usually triggered by some event, and when that event occurs, the source site makes an HTTP request to the URI configured for the webhook.

Note This documentation is meant for webhooks that are incoming into PagerTree. If you are looking for outgoing webhooks, please refer to the documentation here.

How Webhook users benefit from PagerTree

Webhooks are versatile user-defined callbacks that many applications support. PagerTree acts as the dispatcher for these callbacks, determining the right people to notify based on on-call schedules. PagerTree notifies them via email, sms, voice, and/or push notifications until the alert is acknowledged or closed.

Functionality of Integration

The Webhook integration is one-way, meaning:

  • When the payload event_type is create (event_type === "create"), an alert is created in PagerTree automatically.
  • When the payload event_type is acknowledge (event_type === "acknowledge"), an alert is acknowledged in PagerTree automatically.
  • When the payload event_type is resolved (event_type === "resolve"), the alert is resolved in PagerTree automatically.

Tutorial Overview

In this integration tutorial we will show you how to send a Webhook into PagerTree. The estimated time for this integration is 10 minutes. We assume that you already have a PagerTree account setup.

In PagerTree

  1. From the integrations page, click the New Integration” button Click Create Integration Button
  2. Click the logo of the Type of integration you want to create
  3. In the “Create Integration” form, fill out the following:
    1. Name of the Integration.
    2. Select an appropriate Urgency for when this integration is triggered
    3. Select the Team this alert will be assigned to
    4. Any additional options requested by the integration
  4. Click Create
  5. Copy the Endpoint URL Copy Endpoint URL

Configure the Webhook

The calling application must send a POST request with a Content-Type: application/json. The body of the request should have the following values.

Field Type Valid Values
event_type string create/acknowledge/resolve
Id string a unique id
Title string (non-empty)
Description string (non-empty)
Tags string array (optional)
Meta map (optional)
Example Request

You have successfully completed the Webhook Integration. Now when a webhook is triggered, PagerTree will create an alert and route it to the correct team member that is on-call. If you have any questions please contact [email protected]

© 2016-2022 PagerTree LLC. All rights reserved.