You can connect to any type of API you have access to. We support different types of authentication that should meet most requirements.

URL

Enter the URL of the endpoint you want to retrieve data from.

For example:

https://myApiUrl.com
CODE

Variables

You may need to send information about the problem to request the data source. To do this, you can add variable names in curly brackets (like {myCustomVariable}) anywhere within the URL. The value of this variable can be customized in the field configuration later on.

Example:

https://myApiUrl.com?issueId={varIssueID}&key={issueKey}
CODE

Variables can also be used in the content of a POST body.

Authentication

In this section you can define the authentication of the data source you want to connect with. Currently the following methods are supported:

  • No authentication

  • Basic Header (Basic HTTP Authentication)

  • Bearer Token

  • OAuth 2 (see the dedicated section for more details)

  • Custom Auth Header (for API tokens or other header based authentication)

Custom Auth Header

Define a single header name and value that you need for authentication. The header value is separately encrypted and will never be displayed again after saving the data source.

Custom Headers

Define custom headers as needed to individualize the requests sent to the data source. These custom headers will be sent with each request. Enter the name and value of the header you want to add and click the + button to check and confirm it.

Don’t store secrets in this section. Please use the Custom Auth Header authentication instead

Response Type

Defines the response type returned by the data source. Choose either JSONor XML

Ports

The following HTTP ports are supported for connecting to your data source:

  • 80

  • 443

  • 8080

  • 8008

  • 8443

  • 8444

  • 5867

  • 37469

  • 37470

  • 3128

If the port you need is not on the list, feel free to contact our Support.