Provide Instructions in Helpdesk Add Form

Created on 25 August 2022, about 2 years ago
Updated 12 October 2023, about 1 year ago

Problem/Motivation

Currently the page at Configuration > Web Services > Helpdesks > Add Helpdesk (/admin/config/services/helpdesk/add) does not provide details on how each field should be filled out. It would help a lot to provide one-line instructions and/or example placeholder text to help users learn how to fill out the form correctly the first time.

When I filled out the subdomain incorrectly, the Helpdesk View only told me that there was a problem, but didn't tell me what the problem was. Providing instructions in the add form will reduce user errors.

Proposed resolution

Suggested Instructions for each field:

  • Label: Name the helpdesk you are connecting
  • Description: A short description of the helpdesk
  • Subdomain: Example: if your URL is https://ourcompany.zendesk.com, put ourcompany in this field
  • Admin User: the email address of an admin user on your Zendesk account
  • API Token: Generate an API token by going to your Zendesk's Admin Center > Apps and Integrations > API's - create an API key, copy it, and paste it here. Recommend also copying it in a secure place in case you need it again.
  • Max. file size for attachments (in MB): Indicate the size files users can upload to Zendesk tickets, example: 10
  • Closed ticket state: Sync with Zendesk in order for options to show up here. Come back after you've done so and select the closed state.
✨ Feature request
Status

Active

Version

2.0

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States rex.barkdoll

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024