Integrations

⌘K
  2. Home
  4. Docs
  6. Integrations
  8. OnPage Integrations
  10. JIRA

JIRA

Overview

This guide explains how to integrate JIRA with OnPage using JIRA Automation and OnPage Webhooks. This integration allows JIRA issues to trigger OnPage alerts, and responses from OnPage users to be logged as comments in JIRA, with optional automation based on predefined responses.

Prerequisites

  • JIRA Admin Access: Required to set up automation rules.
  • OnPage Admin Access: Required to generate API credentials.
  • OnPage Webhook API Credentials:
    • Visit OnPage Integrations
    • Create a new webhook integration.
    • Copy the Client ID and Secret Key.
  • OnPage Group ID: The recipient ID for alerts.

Step 1: Create an Incoming Webhook in JIRA

This webhook allows OnPage to send updates back to JIRA.

  1. Navigate to JIRA Project Settings → Automation.
  2. Click Create Rule → Choose Incoming Webhook.
  3. Copy the Webhook URL (this will be used as callbackUri in Step 2).
  4. Configure an action to add comments to issues when OnPage sends an update:
    • Action Type: Add Comment to Issue.
    • Comment Body: OnPage Update: {{webhookData.message.body}}
    • (Optional) Add a Condition:
      • If {{webhookData.message.body}} contains "In Progress", transition the issue to In Progress.
      • If {{webhookData.message.body}} contains "Escalate", assign the issue to the escalation team.
  5. Save and Enable the Rule.

Step 2: Create an Outbound Webhook in JIRA (Send Alerts to OnPage)

This automation triggers OnPage alerts when an issue is created or transitions to a specific status.

Setting Up Proper Rules for Issue Triggers

It is critical to define clear rules for when issues should trigger an alert to OnPage. Sending every issue could result in unnecessary noise, while missing key incidents could delay critical response times.

Example: Triggering Alerts for Critical Issues

To ensure only high-priority issues generate OnPage alerts:

  1. Navigate to JIRA Project Settings → Automation.
  2. Click Create Rule → Select Issue Created as the trigger.
  3. Add a Condition → Issue Fields Condition:
    • Field: Priority
    • Condition: Equals
    • Value: Critical
  4. Add an Action → Send Web Request:
    • Webhook URL: https://webhook.onpage.com/gw/v1/page
    • Method: POST
    • Headers: { "Content-Type": "application/json" }
    • Payload (Dynamic with JIRA Smart Values): { "clientId": "<your-client-id>", "secretKey": "<your-secret-key>", "message": { "subject": "{{issue.key}}", "body": "{{issue.summary}}", "recipients": ["<ONPAGE_GROUP_ID>"], "priority": "HIGH", "possibleAnswers": [ "In Progress", "Escalate" ], "callbackUri": "<PASTE_INCOMING_WEBHOOK_URL_HERE>" } }
    • Smart Values in JIRA:
      • {{issue.key}} → JIRA issue key as subject.
      • {{issue.summary}} → Issue summary as body.
    • Replace <your-client-id> with your OnPage Client ID.
    • Replace <your-secret-key> with your OnPage Secret Key.
    • Replace <ONPAGE_GROUP_ID> with the correct OnPage group.
    • Replace <PASTE_INCOMING_WEBHOOK_URL_HERE> with the webhook URL copied in Step 1.
  5. Save and Enable the Rule.

Step 3: Test the Integration

  1. Create a test issue in JIRA matching the trigger conditions.
  2. Confirm OnPage receives the alert.
  3. Respond in OnPage using a predefined response or custom message.
  4. Check JIRA for the update:
    • The OnPage response should appear as a comment.
    • If “In Progress” was selected, the issue should move to In Progress.
    • If “Escalate” was selected, the issue should be reassigned accordingly.

Expected Behavior

  • When an issue is triggered, JIRA sends an alert to OnPage.
  • OnPage users can respond with any message, which is logged as a JIRA comment.
  • If predefined responses (“In Progress”, “Escalate”) are used, JIRA can automate workflow actions.