User Guide
Integration Hub for Jira #iHub
Welcome to the world of integrations!
With Integration Hub for Jira, you can easily create no-code automated REST-integrations to extend, automate and integrate with Jira.
Since integrations can be triggered from either an issue event, scheduled job or a post function the possibilities are endless. REST Request actions can also be chained, using the response from the previous iHub REST request action as input for the chained integration(s).
For non REST calls checkout our Extensions like Kafka.
Getting started
Getting started is easy. Once installed, the iHub user interface is available for the administrator at the applications page. (Cog → applications)
Click the REST-integrations link underneath the RESTFUL INTEGRATOR section to get started.
User interface
Create a new iHub REST Request action by clicking the "CREATE" button
The user interface has 3 sections; Configuration, Triggers, and Execution Log.
Configuration
In this section, you will set up most of the iHub configuration.
Setting | Explanation |
---|---|
NAME | Name of the iHub Rest integrations & automation |
Parent action | Specify a parent iHub Integration. Makes this integration a child to the parent. A child will be executed after successful execution of the parent. |
Method | HTTP Method |
Url | Target endpoint URL |
Authentication Method | Currently supported auth. methods.
|
Headers | Specifies the request headers required for the target endpoint. |
Description | Generic description of what this integration does. |
Body | REST body for the iHub integration REST request |
Variables | Variables are only available for child integrations. This allows you to specify variables based on the parent REST response. Variables are configured by using JSONPath expressions. Read more about this in the chapter "Defining variables" All variables defined will be available in the variable scope that can be used when defining the urls, headers and body. Read more of this in the chapter "Using variables" |
Triggers
You must specify a trigger for your iHub integration in order to wake up the integration.
There are two kinds of triggers for your application:
Issue events
Select the Jira issue event types that you wish your iHub integration to trigger on
Optional: Specify a JQL condition that must evaluate in order for your iHub integration to trigger
Scheduled jobs
Specify a Cron expression that will trigger your integration. Cron expressions are of Quartz format. Hint: Use an online cron maker, ie: http://www.cronmaker.com/
Optional. Specify a JQL context scope for the iHub integration to work on.
Post functions
Post function triggers with and without JQL
Enable integration
New iHub integrations will be enabled by default. If you wish to disable an integration this can be done in the Triggers section.
NOTE
Execution log
Once a iHub integration has been executed you will find the output in the execution log section. This is useful for debugging/monitoring for an application.
Read Log Tab for further info.
Testing an action
Testing an action is easy. Make sure the action is saved, then click the "Test" button.
Enter an issue key for your iHub integration action scope if the action(s) require an issue to work upon. Ie. if there are variable substitutions that refer to an issue. Example: {{issue.key}}
in the URL, body, headers.
Read How to Test an action for further info.
Chained child actions
See the section Chained actions and JSON Path