​

Authentication

This provider requires authentication.

• api_token: Your pagertree APIToken (required: True, sensitive: True)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:

• authenticated: The user can connect to the server and is authenticated using their API_Key (mandatory)

​

In workflows

This provider can be used in workflows.

As “action” to make changes or update data, example:

actions:
    - name: Query pagertree
      provider: pagertree
      config: "{{ provider.my_provider_name }}"
      with:
        title: {value}  # Title of the alert.
        urgency: {value}  # low|medium|high|critical
        incident: {value}  # True if the alert is an incident
        severities: {value}  # SEV-1|SEV-2|SEV-3|SEV-4|SEV-5|SEV_UNKNOWN
        incident_message: {value}  # Message to be displayed in the incident
        description: {value}  # UTF-8 string of custom message for alert. Shown in incident description
        status: {value}  # alert status to send
        destination_team_ids: {value}  # destination team_ids to send alert to
        destination_router_ids: {value}  # destination router_ids to send alert to
        destination_account_user_ids: {value}  # destination account_users_ids to send alert to
        # Additional parameters to be passed

If you need workflow examples with this provider, please raise a GitHub issue.

​

Connecting with the Provider

• To interact with the Pagertree API, you need to provide an api_token.
• You can view and manage your API keys on your User Settings page.

​

Notes

This provider uses the Pagertree API to send alerts or mark them as incidents based on the parameters provided. Depending on whether an incident is flagged as true, it either calls __send_alert or __send_incident method.

​

Useful Links

• Pagertree API documentation: Pagertree API
• Pagertree Authentication: Authentication
• Pagertree Alerts: Alerts & Incident