The post function offers two types of configuration. In the default view you can choose between predefined and directly usable action templates. In the expert mode, actions can be freely defined and configured.
The wizard is the default configuration view of the Execute remote post function. It was built to enable an easy and efficient configuration of common use cases. For those use cases, action templates are shipped with the app, which can be configured in a three-step approach.
Create remote action
At the very beginning, you need to choose an action template that suits your purpose. You can filter those templates by the target service and search across all provided ones. After selecting one, click next to get to the next step.
After selecting an action template, you need to choose the remote service, the action shall get executed against. If you have selected an action template that fits to the target platform, you can select next to your custom connection, the current instance additionally.
If you cannot find a connection that fits, you can easily configure a new one.
After selecting one, click next to get to the next step.
Customize your action
In the last step, you can finish your configuration by setting all the required action template parameters using the set value link next to the parameter name. Some templates have optional parameters that can be chosen using the "Add parameter" action.
Each parameter can be set either by selecting a Jira field that contains an according value or by setting a custom value using the "set value manually option" and passing a parser expression
Besides setting the action parameters, you can also configure fields to be updated after the action has been executed. If provided in the action template, you can set a field using a dedicated part of the remote service's response. In every case, you can store the complete response and the status code of the remote service after executing the action.
After setting the action parameters and optionally storing the service response, you can click "Add" to store the post function in your transition.
The expert mode allows you to act as an expert in many other complex directions and possibilities! You can create your own actions, connections and extend the already created actions!
Here you can define the core parts for setting up the communication with the external service. For this, you need the following:
Within the action parameter you can either choose an existing custom action or create a new one. Additionally, you can select and use any action template known from the Wizard configuration.
An action is composed of:
- REST path
- Action body
Learn more about how to create a custom action!
Within the connection parameter, you can choose or define, where your action get executed against. You can either use the default connection configured in the selected action or override it with a different one. Learn more about creating new connections.
You can use a connection for many actions.
You can only query parameters
|Name||A proper name to describe the parameter|
|Value||You can choose between:|
Please note that only web services providing JSON are currently supported. To easily navigate in JSON structures, you can use the JMESPath.
|Action template specific||Most action templates provide action-specific options to access attributes out of the action body quickly.|
|Response body||Choose if you want to get the whole body of the response.|
|Response status||Choose if you want to get only the status of the response.|
|Set field value manually (parser expression)|
Select the field to copy from using an expression.
Learn more about the possibilities of the JWT expression editor.
- Send email notification: Notification will be sent according to the associated notification scheme.
- Update issues immediately: Choose if you want Jira to fire a separate "Issue updated" event for any field change. This will also result in a dedicated issue history entry.
By default, all the additional options are disabled.
The result of the logical expression must return a boolean value of either:
true→ the post function will be executed
false→ the post function will not be executed
Using the conditional operator, even complex or multi-layered conditions can be constructed.
Make sure to learn more about defining logical expressions and browse through the various examples here: Logical mode
Make sure that the user running the post function has all the relevant permissions to perform the actions defined in the configuration (e.g. "Update Issues")!
If you want to keep track the actions being performed automatically, we suggest to create a dedicated JWT account, granted all relevant permissions, and use it in the Run as parameter to identify which changes have been made with JWT.
Use cases and examples
|Use case||JWT feature||Workflow function||Parser functions||Label|
|Create an external link remote action|
|Create an issue comment remote action|
|Create a page remote action|
|Create a project component remote action|
|Create a project remote action|
|Create a space remote action|
|Create a user remote action|
|Create a version remote action|
|Get related assets (Insight) remote action|
|Invite a user remote action|
|Link an issue remote action|
|Log work remote action|
|Transition an issue remote action|