Service Desk widget configuration
Apart from the full Service Desk application, we offer a simplified widget that you can embed to your website or any other page. It can be useful if you do not need the full Service Desk application, or if you just need your users to submit issues, ideas, or questions without leaving your site.
The widget is configurable. Depending on what you need, it can as simple as just a single line with a subject:
Or, it can include additional fields such as description, request type selector, privacy selector, attachments, and even display a "Top x ideas", where you define the number of requests to display. You can also define whether requests will be private or public by default.
In order to embed the widget to your site or application, all you need is to provide a link to your Service Desk that will be displayed in a frame. Parameters are passed in the URL to the widget.
To let the widget work correctly, your service desk settings should allow registration of new requesters. Set New users can register on their own option to checked.
Supported options
| Field Name | Type | Default | Required | Note | Example |
| product_id | number | n/a | yes | Defines project/product where all feedback from widget is submitted to | …/widget?product_id=123… |
| string | n/a | yes | Default creator of the request submitted via the widgetNote: You can get the email of the logged user to your site or application and pass it to the url | …/widget?...&email=feedback@example.com | |
| firstname | string | n/a | no | First Name of default creator | …/widget?...&firstname=John |
| lastname | string | n/a | no | Last Name of default creator | …/widget?...&lastname=Doe |
| show_top_requests | boolean | false | no | Show/hide panel of requests that have the most votes | …/widget?...&show_top_requests=true |
| show_request_types | boolean | false | no | Allow users to select a type of request, ex issue or idea | …/widget?...&show_request_types=true |
| show_description | boolean | false | no | Show/hide description field | …/widget?...&show_description=true |
| show_attachments | boolean | false | no | Allow users to upload attachments to requests | …/widget?...&show_attachments=true |
| default_is_private | boolean | public* | no | Defines if a request should be private by default*If the Service Desk is in private mode, the field is not available | …/widget?...&default_is_private=true |
| default_request_type | number | first available | no | Defines default Request Type by provided id. Usually, 1 is for issues, 2 for ideas | …/widget?...&default_request_type=2 |
| top_requests_count | number | 10 | no | Defines how many top requests to show, works only with show_top_requests=true | …/widget?... &show_top_requests=true &top_requests_count=5 |
| show_email | text | false | no | Allow users to specify their email address. If the email is not set, Default Author parameter will be used | …/widget?...&show_email=true |
So the full link with all the parameters may look something like:https://your_service_desk/widget?form_title=Help%20us%20improve&product_id=49105&email=feedback@example.com&show_top_requests=true&show_request_types=true&show_description=true&show_attachments=true&default_is_private=true&default_request_type=2&top_requests_count=6
Not very convenient to use, right? That's why we also added a compact way to pass the parameters. Instead of using the full parameter name, you can specify just the values in the same order as the parameters are listed in the table above.
https://your_service_desk/widget?product_id=123&email=feedback@example.com&options=123,1,1,0,0,1,2,5
This opens a widget for a product with id == 123, shows Top Requests and request types, hides description field and attachments panel, defines requests to be isPrivate = false by default, defines default request type with id == 2, and defines number of requests to show == 5.