Link Button
Configure a button to open a link or send an HTTP request, insert system data through snippets and display the response.
Link Button is a configurable button that an administrator can make available to system users. When clicked, the button performs an action defined in its configuration.
The button can simplify everyday tasks, such as opening a map, accessing another system, retrieving ticket information, or sending data to an external application. This allows users to perform specific actions without manually searching for addresses or copying data.
Link Button supports two action types: Link and Request. These settings are available after pressing the button.
Link button sections:
1. Purpose
Action types
Link
The Link action opens specified web addresses or launches supported external applications.
Example use cases:
- opening a map showing a location;
- navigating to a website or a tool used at work;
- opening an application such as TeamViewer or AnyDesk.
The administrator specifies the address to open and chooses whether it should open in the same browser window or in a new tab.
Request
The Request action sends requests to other systems, for example, to retrieve information or transfer data. It can be used to communicate with an API, an interface that allows applications to exchange data.
Example use cases:
- retrieving the current status of a ticket;
- sending ticket data to another system;
- updating selected information in an external application;
- displaying the result of an operation.
In this mode, the administrator can specify the request method, destination address, and data sent to the external system.
Using system data
In Request mode, snippets can be used to reference data available in the system. This allows the button to send information related to a specific ticket, user, asset, or contract.
Snippets can be added using the snippet builder, opened by clicking the scissors icon. Instead of entering the snippet syntax manually, the administrator selects a category and a field from which to retrieve a value. The system automatically inserts the appropriate expression.
Available categories include:
- system data;
- user data;
- ticket data;
- asset data;
- contract data.
Categories may also contain custom fields created for a specific system configuration.
For example, a button can send a ticket ID or the value of one of its fields to an external system. Values are retrieved from the relevant system data, allowing the same button configuration to be used for different records.
Displaying responses
In Request mode, the Wait for response option can be enabled to configure how a response from an external system is displayed.
When this option is enabled, the Response modal HTML template field becomes available. It allows the administrator to define the appearance of the response.
The template uses HTML and can also use AngularJS. The response is
available through the {{response}} variable.
This allows the administrator to present the result in a clear and readable format, for example, in a window with a heading and formatted content. The template can be adapted to the type of data returned by the external system.
Example use cases
Link Button can simplify many everyday tasks, for example:
- Opening a map — a Link button opens a map address in a new browser tab.
- Retrieving ticket status — a Request button sends a GET request to an external API.
- Sending ticket data — a Request button sends data to another system, for example, using the POST method.
- Updating information — a Request button sends data required to update a record in an external system, for example, using the PATCH method.
- Sending data automatically — snippets allow the request to include a ticket ID or the value of a custom field.
- Displaying operation results — the Wait for response option and the Response modal HTML template allow the user to view the response received from an external system.
The button’s behavior depends on its configuration and the capabilities of the system it communicates with.
2. Configuration
The button is configured in the administration panel after pressing the button. Under Action type, select the Link or Request tab, depending on what the button should do.
After selecting the appropriate tab, complete the required fields and adjust the remaining settings as needed.
2.1. Link configuration
The Link tab allows you to configure a button that opens a specified address. Below are the options you can or should select for proper configuration.
Show warning before opening the link
This option displays a warning before opening the link.
Select this option if users should receive a warning before navigating to the specified address.
Button
This section allows you to specify the text displayed on the button.
Button text
Here you can enter the button label which will be visible for the user. This field is required. For good responsiveness please use short, clear labels that indicate what will happen when the button is clicked.
Link settings
This section allows you to configure the link address and how it is opened.
Link address
Enter the address that will be opened when the button is clicked. This field is required.
The Allowed formats information below the field provides examples of supported address formats:
google.comhttps://google.comhttp://google.comwww.google.comTeamViewerAnyDesk
The field can be used to open websites and addresses associated with external applications. Launching an external application depends on whether it is installed and correctly configured on the user’s system.
For websites, HTTPS addresses are recommended.
Where to open the link
Select how the address should be opened.
Available options:
- In the same window — opens the address in the current browser window.
- In a new tab — opens the address in a new browser tab.
Saving the configuration
After completing the required fields, you can save the button configuration.
- Save — saves the configuration.
- Cancel — cancels editing.
Before saving, check that the Button text and Link address fields have been completed.
2.2. Request configuration
The Request tab allows you to configure a button that sends a request to a specified address. This can be used to communicate with other systems, for example, to retrieve information, send data, or perform an operation using ticket data.
In this tab, you can specify the request method, where the request is executed, the destination address, and additional options for handling the request and its response.
Show warning before executing the request
This option displays a warning before the request is sent.
Select this option if users should receive a warning before an operation is performed. This can be useful when a request sends data to another system or changes existing data.
Button
This section allows you to specify the text displayed on the button.
Button text
Here you can enter the button label which will be visible for the user. This field is required. For good responsiveness please use short, clear labels that indicate what will happen when the button
Request settings
This section allows you to specify how the request is sent and where it is sent.
Method
Select the HTTP method that defines the type of operation to perform.
Available methods:
- GET — retrieves information from the target system.
- POST — sends data to the target system, for example, to create a new record or initiate an operation.
- PUT — sends data to create or replace a resource, depending on how the target system works.
- PATCH — sends data to update selected information.
- DELETE — sends a request to delete a resource in the target system.
Choose a method that matches the requirements of the system receiving the request.
Where to execute the request
Select where the request should be executed.
Available options:
- Frontend — the request is executed in the user’s browser.
- Backend — the request is executed on the server side.
The appropriate option depends on the integration method and the requirements of the operation.
Request address
Enter the address to which the request will be sent. This field is required.
Example address:
https://api.example.com/resource/123
The address should point to an API endpoint or another service that supports the selected request method.
Below the field, a button with a scissors icon opens the snippet builder. It allows you to insert values from system data, such as a ticket ID or a custom field value.
This allows the address to be adapted to the record for which the user clicks the button.
JSON body
This field specifies the request body in JSON format. It is available for the POST, PUT, and PATCH methods.
The JSON body can contain data sent to the target system. Snippets can also be used to populate the request body with values from the system.
For example, you can send a ticket ID and its status to an external system.
The JSON body field is not displayed for the GET and DELETE methods.
Additional options
Trust all certificates
This option relates to the verification of certificates used when connecting to the target system.
Use this option with caution. In production environments, it is recommended to leave it disabled unless there is a specific reason to change how certificates are verified.
Wait for response
Select this option if the button should wait for a response from the target system and make it available for display to the user.
When this option is enabled, the Response modal HTML template field becomes available, allowing you to define how the response is displayed.
Response modal HTML template
This field appears when Wait for response is enabled. It allows you to create an HTML template that defines how the response from the target system is presented.
The template can use AngularJS, and the response is available through
the {{response}} variable.
Example of a simple template:
<div>
<h3>Operation result</h3>
<pre>{{response}}</pre>
</div>
In this example, the response is displayed under the heading
“Operation result”. The pre element preserves the formatting of
the displayed text.
The template can be adapted to the type of data returned by the API.
Saving the configuration
After completing the required fields, you can save the button configuration.
- Save — saves the configuration.
- Cancel — cancels editing without saving the changes.
Before saving, check that the Button text and Request address fields have been completed. Adjust the remaining settings to meet the requirements of the operation.
3. Configuration examples
3.1. Opening a map — Link
To create a button that opens a map, configure it as follows:
| Field | Value |
|---|---|
| Action type | Link |
| Button text | Open map |
| Link address | Address of the selected map |
| Where to open the link | In a new tab |
You can enable Show warning before opening the link if a warning should be displayed before opening the address.
After completing the fields, click Save to save the configuration.
When the user clicks the Open map button, the configured address opens in a new browser tab.
After clicking, if Show warning before opening the link was checked, the warning modal will appear
If the address needs to be generated using ticket or asset data, check whether the Link address field supports dynamic value substitution mechanisms such as snippets.
3.2. Retrieving ticket name — Request
The administrator wants to provide users with a button that retrieves a ticket name from the specified ticket that user is checking at the moment. When the button is clicked, the system sends a request to an API and then displays the response.
Example configuration:
| Field | Value |
|---|---|
| Action type | Request |
| Button text | Get ticket name |
| Method | GET |
| Where to execute the request | Frontend |
| Request address | API address containing the ticket ID |
| Trust all certificates | Disabled |
| Wait for response | Enabled |
In the Request address field, enter the appropriate API endpoint.
If the address needs to include the current ticket ID, you can insert
it using the snippet builder, available by clicking the scissors icon.
In this particular example, if a user is viewing a specific ticket, the
{{TicketId}} snippet will be replaced with the ID of the ticket the user is currently viewing
For example, the address could look like this:
https://mintsd.opgksoftware.com/api/tickets/{{TicketId}}
To display the response received from the target system, enable Wait for response. Then use the Response modal HTML template field to create a template for displaying the returned data - in our example we want only the name parameter.
Example template:
<div>
<strong>Ticket name:</strong> {{response.data.name}}
</div>
You can easily manage the response view by entering HTML code along with styling.
Example configuration below:
After saving the configuration, users can click the Get ticket status button.
The system sends a GET request to the specified address, and the response is made available in the configured window.
The actual result depends on the data returned by the API and the configuration of the target system.