Skip to content

Creating and Linking Issues

This page uses “issue” for GitHub, GitLab, Jira, and Linear. It uses “work item” for Azure DevOps.

You can create a new issue or work item from the Git-Zen app, in any of your linked repositories, projects, or teams. Git-Zen adds a Git-Zen reference tag to the description. This links the new item to the ticket. You can create and link more than one item from the same ticket. The items can be in different repositories.

The same item can be linked to more than one Zendesk ticket.

To begin, click the Create button in the menu bar.

The Create Issue button

The Create Issue window opens.

The Create Issue window for GitHub

Select which linked GitHub repository to create the issue in.

Git-Zen fills the title with the ticket subject, and the description with the latest ticket comment. You can change both. An administrator can set a custom default title and description or a custom body format.

If an administrator set Allowed Status for Creation, the Create button works only on tickets with one of those statuses.

If the repository has issue templates, they appear in a drop-down list.

The issue template drop-down

A template applies its title, description, and assignees. If the template includes labels, Git-Zen applies them in addition to the default labels in your settings.

The Include Zendesk Ticket Header option

When you check Include Zendesk Ticket Header, Git-Zen adds a descriptive header with details about the Zendesk ticket to the description.

A Zendesk ticket header in a GitHub issue

The header names the agent who escalated the ticket. It also shows the ticket number (as a link), type, priority, requester, organization, and assignee. To check the box by default, turn on Include ticket header by default in the settings.

Use the quick links above the description field to put ticket comments in the description. Click All for the full comment thread, Latest for the latest comment, or OP for the first comment. An administrator can hide these links. If AI summaries are on for your account, a Summary link also shows. It puts an AI summary of the ticket in the description. There is no switch for this in the settings. To turn it on, contact support.

The quick links above the description field

The description field supports Markdown.

On GitHub, GitLab, and Azure DevOps, when the form shows the Assigned To field, you can also type @ to see a pop-up list of users. Select a user to add the name to the text. The hint does not show on other platforms.

If the ticket description or any comment has attachments, they appear in the Include Attachments drop-down. Select an attachment to add it to the new item. Attachments are available on GitHub, GitLab, and Azure DevOps. Jira and Linear do not support attachments from Git-Zen.

The Include Attachments drop-down

To add an attachment that is not in a ticket comment yet, click upload new.

The upload new link

To select all attachments at once, click select all.

Scroll down for more fields. The drop-down lists come from the configuration of the repository, project, or team you selected.

Additional fields for a GitHub issue

You can add labels, assign users, and select a milestone and a project. You can also type a new label to create it. The labels field starts with the default labels from your settings.

When you have set all the options, click Add Issue (or Add Work Item on Azure DevOps). Git-Zen creates the item and links it to the Zendesk ticket.

The Add Issue button

If your authorization has expired or was revoked, Git-Zen does not create the item. A message tells you to re-authorize your token, or to update your personal access token. See Authorization problems.

The new item shows at once in the linked list, with the status Linking. When the webhook event arrives from your platform, the row shows the full item. If Zendesk rejects the update, the row disappears and a message gives Zendesk’s reason. If nothing confirms the link within 90 seconds, the row shows Not confirmed. See Troubleshooting.

You can link an existing issue or work item from Zendesk, or from your platform.

When you link an item from Git-Zen, Git-Zen adds a reference tag to its description. You can link more than one item to the same ticket. The items can be in different repositories. You can link the same item to more than one ticket.

Click the Link button in the menu bar. The Link Issue (or Link Work Item on Azure DevOps) window opens.

The Link Issue button
The Link Issue window
  1. Select the repository, project, or team (the first drop-down) that holds the item.
  2. Select the item (the second drop-down). It lists open items that are not already linked to this ticket. You can search it. Type part of the title or the item number to filter the list.
  3. Optionally, add labels or tags in the Additional labels for issue (or Additional tags for work item) box. It starts with the default labels or tags from your settings. An administrator can turn this box off. Agents with the Limited level do not see it.
  4. Click the red Link button at the bottom of the window.

The list of work items only includes items of certain types and statuses. These depend on your work item type settings and work item status settings. If a work item you expect is missing, check these settings.

You can also link an item, or an item you are creating, from inside your platform. Add a Git-Zen reference tag for the Zendesk ticket (or tickets) anywhere in its description, then save.

  1. Open the issue in your browser and click the actions button.
    The issue actions button
  2. Click Edit.
    The Edit option
  3. Add the reference tag to the description and click Update comment.
    A reference tag in the description

The Zendesk ticket now has a link to the item. The item shows in the linked items list in Git-Zen after the webhook event arrives from your platform.