Configuring JSM Alerts to Receive alerts via webhooks

Create the integration in JSM

  1. Settings → Products → Jira Service Management → Integrations → Add integration

  2. Select API

  3. Name the integration and select an assignee team

  4. Copy the API key:

Create the webhook in Email This Issue

  1. Open Email This Issue → Administration → Webhooks → Add → Add custom webhook

  2. Fill out the required details:

    1. Name: custom name

    2. Description

    3. Event: select the event you want to create the alert for (reference our Alerting via Webhooks article for the available event types).

    4. Service URL: https://api.atlassian.com/jsm/ops/integration/v2/alerts

    5. API Token - paste the API key from step 3 above.

    6. Request Header: Authorization: GenieKey $!token

    7. Request Body: a JSON-formatted message payload that contains JSM parameters with either hard-coded values or values from our variables.

{
    "message": "$!message",
    "alias": "$!entity.type - $!entity.id",
    "description": "$!details",
    "tags": [
        "Critical"
    ],
    "details": {
        "Entity Name": "$!entity.name",
        "Entity Type": "$!entity.type",
        "Entity ID": "$!entity.id",
        "Entity Link": "$!entity.link",
        "Jira Base Url": "$!jiraBaseUrl",
        "Incident Timestamp": "$!timestamp"
    },
    "entity": "Email This Issue",
    "priority": "P1"
}

In the above example we provide a lot of information in the details parameter, to see this in the alert itself, you need to edit the rule in JSM side to save the information to specific alert fields.

Last updated

Was this helpful?