mirror of
https://github.com/caronc/apprise.git
synced 2024-12-04 05:54:35 +01:00
3
Notify_pagertree
Chris Caron edited this page 2023-02-16 19:00:38 -05:00
PagerTree Notifications
- Source: https://pagertree.com
- Icon Support: No
- Attachment Support: No
- Message Format: Text
- Message Limit: 32768 Characters per message
- For this to work, you'll need to signup for a PagerTree account (free trial is fine). Make sure you follow the setup wizard (you'll want to be on-call for the team the integration is pointed to in Step 2)
- Create a webhook integration and point it to the team (default: "Devops Team")
- From the integration page, copy the integration Prefix ID (used for the apprise url)
- Use the Prefix ID for the apprise URL
./bin/apprise -t test -b message "pagertree://int_xxxxxxxxxx"You need to have an account with PagerTree and create a webhook integration.
Syntax
Valid syntax is as follows:
pagertree://{integration}pagertree://{integration}?action=resolve&thirdparty_id=abc123pagertree://{integration}?+pagertree-token=123&:env=prod&-incident=true&-incident_severity=SEV-1&-incident-message=Please join the bridge&tags=prod,server,outage
Parameter Breakdown
| Variable | Required | Description |
|---|---|---|
| integration | Yes | This is the Prefix ID of your webhook integration. Found at the top of the integration page. |
| action | No | The action for the webhook. Possible values are create, acknowledge, and resolve. When using acknowledge or resolve, please use the thirdparty_id parameter to indicate to PagerTree which alert should be actioned. |
| thirdparty | No | An Id PagerTree uses to map thirdparty applications to alerts. You can specify your own, or if not, a random UUID will be generated for you. |
| urgency | No | Urgency of the alert to be generated. Possible values silent, low, medium, high, or critical. If not provided, PagerTree will use the integration's default. |
| tags | No | Comma seperated list of tags. (ex: "prod,server,outage") |
Example
Send a PagerTree create command.
# Assuming our {integration_id} is int_0123456789
apprise -vv -t "Test Message Title" -b "Test Message Body" \
"pagertree://int_0123456789"
Payload Manipulation
Making use of the : on the Apprise URL allows you to alter and add to the body content posted upstream to PagerTree. This is useful when using the Capture Additional Data feature.
# Add to the payload delivered to PagerTree
#
# Assuming our {integration_id} is int_xxxxxxxxxx
# Assuming we want to include "server": "blue-ranger-2" as part of the existing payload:
apprise -vv -t "Test Message Title" -b "Test Message Body" \
"pagertree://int_xxxxxxxxxx/?:server=blue-ranger-2"
The above would post a message such as:
{
"id": "0f85aa1c-711e-4873-95b6-e441c291537d",
"action": "create",
"title": "Test Message Title",
"message": "Test Message Body",
"server": "blue-ranger-2"
}
Header Manipulation
Some users may require special HTTP headers to be present when they post their data to PagerTree. This can be accomplished by just sticking a plus symbol (+) in front of any parameter you specify on your URL string. This is useful when making use of the PagerTree Token feature.
# Below would set the header:
# pagertree-token: abcdefg
#
# Assuming our {integration_id} is int_xxxxxxxxxx
apprise -vv -t "Test Message Title" -b "Test Message Body" \
"pagertree://int_xxxxxxxxxx?+pagertree-token=abcdefg"
Meta Manipulation
Some PagerTree functionality (like incidents) lives in the meta property of the payload. To add to the meta property you just need to prefix your entries with a minus (-) symbol. See example.
# Indicate to PagerTree this alert should be marked as an incident
# The `-` symbol will get stripped off when the upstream post takes place
# Apprise knows not to do anything with the argument at all and pass it along as is.
apprise -vv -t "Test Message Title" -b "Test Message Body" \
"pagertree://int_xxxxxxxxxx?-incident=true&-incident_severity=SEV-1&-incident_message=Join the war room"