You can connect to any kind of API that you have access to. We support various ways of authentication that should fit most needs.

URL

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

https://myApiUrl.com
CODE

Variables

You might need to send information about the issue requesting the data source. You can achieve this by adding variables into the URL field. Surround a variable name with curly brackets like {myCustomVariable} anywhere within the URL. The value of this variable can be configured later in the field configuration. An 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 Headers

Define custom headers as needed to individualize the requests send to the data source. Those custom headers will be send with every request. Enter the name and value of the header you want to add and click the + button to verify and actually add it.

Response Type

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

Ports

You can connect to your data source by using one of the following HTTP ports:

  • 80

  • 443

  • 8080

  • 8008

  • 8443