Update configuring-autolinks-to-reference-external-resources.md

[Oyahaji]

---

title: Configuring autolinks to reference external resources intro: You can add autolinks to external resources like JIRA issues and Zendesk tickets to help streamline your workflow. product: '{% data reusables.gated-features.autolinks %}' redirect_from:

• /articles/configuring-autolinks-to-reference-external-resources
• /github/administering-a-repository/configuring-autolinks-to-reference-external-resources
• /github/administering-a-repository/managing-repository-settings/configuring-autolinks-to-reference-external-resources versions:
  fpt: ''
  ghes: ''
  ghec: '*'
  topics:
• Repositories shortTitle: Configure autolinks

---

About autolinks

Anyone with admin permissions to a repository can configure autolink references to link issues, pull requests, commit messages, and release descriptions to external third-party services.

Autolink references can now accept alphanumeric characters. When originally introduced, custom autolinks were limited to external resources that used numeric identifiers. Custom autolinks now work with alphanumeric and numeric identifiers.

You define custom autolinks by specifying a reference prefix and a target URL.

• Reference prefixes cannot have overlapping names. For example, a repository cannot have two custom autolinks with prefixes such as TICKET and TICK, since both prefixes would match the string TICKET123a.
• Target URLs include a <num> variable which represents the reference identifier of the linked resource.

Configuring autolinks to reference external resources

This procedure demonstrates how to configure autolinks to reference external resources. For example, if you use Zendesk to track user-reported tickets, you can reference a ticket number in the pull request you opened to fix the issue.

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %}

1. In the "Integrations" section of the sidebar, click {% octicon "cross-reference" aria-hidden="true" aria-label="cross-reference" %} Autolink references.

2. At the top right of the page, click Add autolink reference.

   

3. Select the format of the reference identifier used in the external resource, either Alphanumeric or Numeric.

4. Under "Reference prefix", type a short, meaningful prefix. Collaborators will use this text to generate autolinks for the external resource.

5. Under "Target URL", type the format of the link to the external system you want to create. Use the <num> variable as a placeholder for the reference identifier.

6. Review the preview and verify that the autolink and external reference are both correct, then click Add autolink reference to define the link.

For example, you might enter the following.

• Reference prefix: JIRA-
• Target URL: https://jira.example.com/issue?query=<num>
• Preview: JIRA-123 is converted to https://jira.example.com/issue?query=123

Why:

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

• A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
• The changes in this PR meet the docs fundamentals that are required for all content.
• All CI checks are passing and the changes look good in the review environment.

[welcome]

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[github-actions]

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

• Spin up a codespace
• Set up a local development environment

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source	Review	Production	What Changed
repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md	fpt ghec ghes@ 3.17 3.16 3.15 3.14	fpt ghec ghes@ 3.17 3.16 3.15 3.14

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.