Setting up an external application

To enable Tracker to exchange data with an application, configure basic link functionality: network access and authentication.

To ensure that Tracker supports advanced functionality of links to your application, such as displaying detailed information about linked objects, you need to implement support for these features in the application.

Configuring basic link functionality

Network access

Your application must be available via a public address on the internet.

Authentication

To authenticate requests sent from Tracker to external applications, you can use one of the following approaches:

  • Without authentication

  • OAuth

    A token used to authenticate a request from Tracker to an external application is passed in the request header.

Use the Tracker API to create or remove links to your external application:

Configuring advanced link functionality

Getting information about linked objects

To enable the Tracker interface to display detailed information about a linked object, the application should pass the following information upon request:

  • Method: GET

  • URL: scheme://host:port*{{remoteKey}}*

    where:

    • remoteKey is the key of the linked object in the application.
    • * is any sequence of characters.

    For example: https://my-app.ru:8080/1234/info

Expected response format: A list of parameters in JSON format.

Parameter

Type

Description

key

String

Object key. Required.

summary

String

Object name. Required.

iconUrl

String

Icon URL. Optional.
Use this when you want to show a different icon for items in a certain status.

status

Object

Object status. Optional.
Contains the following fields:

  • name (string): Name.
  • description (string, optional): Description.

resolution

Object

Resolution. Optional.
Contains the following fields:

  • name (string): Name.
  • description (string, optional): Description.

assignee

Object

Assignee. Optional.
Contains the following fields:

  • trackerUid(long integer, optional): Tracker user ID.
  • passportUid (long integer, optional): Yandex ID (previously Yandex.Passport) user ID.
  • login (string, optional): Username.

updated

String

Update date and time in YYYY-MM-DDThh:mm:ss.sss±hhmm format. Optional.

deadline

String

Deadline in YYYY-MM-DDThh:mm:ss.sss±hhmm format. Optional.