Start integrating with ONEiO for free!
SIGN UP

Endpoint Type Configuration Guide - Atlassian Jira

Endpoint details

In this document, you will find detailed info about Atlassian Jira Endpoint Type. This Endpoint Type is a Self-Service type, so users can add them without the need to reach out to ONEiO Support. 

ONEiO_Jira_Endpoint_Type.png

  

  General
Status Sets the status of the endpoint. Active / Suspended
URL The base address of your Jira. You can test the HTTP connection by clicking Test Connection button. Note that this function does not test the authentication, only if ONEiO can reach the endpoint.
Name Name of the endpoint. It is recommended to use short names since this name is used in displays throughout ONEiO.
Datetime pattern Date time pattern ONEiO uses to read DateTime fields and how ONEiO sends out DateTime fields. Shown only for reference.

 

  [YourJira] -> ONEiO
Webhook details  
Webhook target address Target address to put to Jira's webhook configuration.
Inbound authentication In edit mode, you can retrieve the authentication token to insert to [CUSTOMER_SPECIFIC_TOKEN] in the Webhook target address
Inbound Whitelist Filter

With this property, you can define conditions to allow messages from Jira. This is typically used to filter out messages that are triggered by ONEiO, since there is no way to filter those out in Jira's Webhook configuration. Another typical use-case is to allow only messages for a certain project since Jira has limitations to filtering against project values as well. 

You can have one or more conditions. The different conditions are separated with comma (,). The logical operator between conditions is always "AND". Supported operations in a single condition are:

  • = (or ==) for EQUALS
  • != for NOT EQUALS
  • IN which evaluates to true if any of the values in the list are equal to the value compared to.

Example: attr_1=foo,attr_2==${param:project.key},attr_3!=${username},attr_4 IN (bar1, bar2, bar3)

Entity Type Resolving ONEiO needs to resolve the Entity Type from the inbound message. This configuration describes from what information it is done. 
Resolving Path The field in the inbound message where the resolving is read from.
Resolving Values Value matched is resolved to Entity Type.
Fallback Entity Type If no value is matched, the inbound message is resolved as the Entity Type defined here.

 

  ONEiO -> [YourJira]
Integration user in Jira The user that is used in all calls to Jira's API. These include updates and lookups.
Password (API Token) The password or API token to the integration user. Jira Cloud always requires API token, but some older on-prem Jiras might still use the password of the user.
Unrecoverable HTTP error codes List of numeric HTTP response codes that are to be handled as non-recoverable when sending messages to Jira's API. If ONEiO receives an error code that is not on the list, it will retry the message automatically. If ONEiO receives an error code that IS on this list, the message will result in an error.

 

Entity types

Jira endpoint comes with two default entity types; Incident and Service Request. The entity type on ONEiO is equivalent to Jira's Issue Type. There is no need to use these ones, but you can use them as examples in case you wish to use some other Entity Types. You can add new Entity Types freely. Remember to include the new Entity Type into the Resolving table in the "General Info" tab.

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.