Isthmus – connecting REST APIs

Example setup

1. Set up an incoming webhook on Slack
2. Define a filter in JIRA (you could also query directly using JQL, but using a filter allows for adapting the query without changing your Isthmus setup)
3. Define a new scheduled rule with:
   • CRON expression: 0 15 19 ? * THU
   • Query URL:

     https://www.mycompany.com/jira/rest/api/2/search?jql=filter='Filter for Isthmus'

   • Provide username and password with access to JIRA and the provided filter
   • FreeMarker template

     {
               "text": "Tasks in progress for tomorrow:\n<#list issues as issue><https://www.mycompany.com/jira/${issue.key}|${issue.key} - ${issue.fields.summary}>\n</#list>",
               "username" : "Isthmus",
               "icon_emoji" : ":heavy_exclamation_mark:", 
               "channel" : "jira-updates"
           }

   • Method: POST

   • https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX

• The Notification plugin sends JSON via HTTP, but in our tests it never reported any SCM changes
• The precursor to above plugin, jenkins-notify-plugin, allows for templating the payload, but requires manual installation (and seems to be discontinued)
• Create a JSON payload from scratch and use cURL .. ok, let's do that

Example setup

1. Extend your declarative pipeline with
   • Implement some form to retrieve your SCM change list as eg. changelistJSON

   • script {
             payload = changelistJSON()
             echo "Sending JSON to Isthmus: ${payload}"
             sh "curl -d '${payload}' -H "Content-Type: application/json" -X POST http://localhost:8087/isthmus/webhooks/jenkins"
           }

     (the -X POST here is unnecessary, but illustrates that we're sending POST)
2. Define a new webhook rule with:
   • /webhooks/jenkins
   • 'Payload must match' remains empty
   • 'Path to payload root for template' stays empty (indicating we're using the full payload)
   • FreeMarker template

     {
             "update": {
               "labels": [{
                 "add": "deployed"
               }]
             }
           }

   • Method: PUT

   • http://localhost:8081/jira/rest/api/2/issue/${key}

   • Username + password to access JIRA

Example setup

1. Define a 'post-receive' git hook:

   #!/bin/bash
         read oldrev newrev _branch
         branch=$(echo $_branch | sed 's/.*\/\([a-z0-9][a-z0-9]*\)$/\1/')
         commit_message=$(git log -1 --pretty=format:'%h %cn: %s%b' $newrev)
         curl --header 'Content-Type: application/json' --data "$commit_message" http://localhost:8087/devtaskhub/webhooks/git &

2. Define a new webhook rule with:
   • /webhooks/jenkins
   • Set a 'Payload must match' to .*FUN-.* with type RegExp
   • Set 'Path to payload root for template' to .*?: ([\w-]+).*
   • FreeMarker template

     {
             "update": {
               "labels": [{
                 "add": "code-changes"
               }, {
                 "remove": "deployed"
               }]
             }
           }

   • Method: PUT

   • http://localhost:8081/jira/rest/api/2/issue/${group1}

   • Username + password to access JIRA