# GitHub

The GitHub integration makes it easy to follow GitHub work without leaving Glue. When you share a GitHub link, Glue shows a rich preview with the latest details and keeps the conversation up to date as issues and pull requests change.

### GitHub Link Previews

GitHub link previews in Glue automatically display rich information when you share GitHub links in conversations. These previews show key details about repositories, pull requests, issues, commits, and files without requiring you to leave the conversation. Statuses will update in real time in these previews.

When you paste a GitHub URL into any Glue conversation, the system automatically detects it and generates a rich preview.

<figure><img src="/files/BL5HXnRRPPCGwmY9VadG" alt=""><figcaption></figcaption></figure>

### Auto-Subscribe to GitHub Updates

When you share a GitHub issue or pull request link in a thread, Glue automatically subscribes the thread to updates for that issue or PR. Whenever the status changes (e.g., an issue is closed or a PR is merged), a system message is posted to the thread so everyone stays informed.

<figure><img src="/files/9GcvzYsoI6c4tdYkB42N" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
You don't need to add the GitHub app to a thread to auto-subcribe to updates— just share a link with the link preview. If you do not want your thread subscribed to updates, remove the link preview before sending.
{% endhint %}

<figure><img src="/files/agUyjfFw5pQbWEuc3hFe" alt=""><figcaption></figcaption></figure>

### Trigger new threads or messages based on GitHub activity

Add the app to a Group or Thread

<details>

<summary>Add the GitHub app to a group* or thread</summary>

The GitHub app can be added to either a group or a thread:

* Group: When adding the GitHub app to a group, it can be configured to either create new threads or send updates to the Group chat.
* Thread: The GitHub app will send notifications to the thread.

To add the GitHub app to a group, navigate to the group and then choose **Apps** from the menu to open the Apps tab of the group settings.

![](/files/jfelRZ7SFd0UpVKcEtbD)

To add the GitHub app to a thread, navigate to the the thread and then choose **Thread Settings** from the menu. With the settings open, choose the **Apps** tab.

![](/files/g34MqY4hIBKvbhGc6AnU)

From the **Apps** tab of either a group or thread, click to add GitHub.

![](/files/0pOxxpk2127czEmcsoE6)

A modal will appear where you can connect a repository.

</details>

<details>

<summary>Connect a repository</summary>

After adding the GitHub app to a group or thread, you will need to choose and configure GitHub repositories that you want to receive updates for.

Start by clicking **Connect a Repo**

![](/files/BjYPhjoGQIQ9W6mGSKoR)

When connecting your first repository, you'll be ask to sign in to GitHub. Click **Authorize.**

![](/files/GchXgDhWKs9iP7F5BOSW)

A window will appear where you can log in to GitHub. Click **Authorize** to let Glue access your account.

![](/files/QdBU6C6G34MUErmvIl9Q)

After logging in, you'll be asked to install the Glue app for GitHub to you GitHub organization. Click **Install.**

![](/files/iO4Ee3egDNqmLydzBtp2)

A window will appear where you can choose a GitHub organization. When choosing repositories, make sure to choose all of the repositories you want to use with Glue, not just the ones you want to use with the selected group or thread. You won't receive updates for any repos until you configure them later in Glue and you can configure different repositories for different groups/threads. When you're done, click **Install**.

![](/files/tqIiXVErNgQuM3hmh5Xn)

After signing in and installing the app, choose a Repo from the list and then click **Add**

![](/files/hOuN11vvJbmg4Vd3Fz0q)

Choose which events you want to receive messages for and then click **Next**.

![](/files/SazJKZ8AhTziYW0DgtVe)

If you're connecting a repo to a group, you'll be asked whether you want to send all updates to the group chat or create threads for each Issue, PR, etc.

![](/files/4hWswfanF7X8OYeIsaDq)

The repo you added will now appear in the list of repos connected to the group or thread you selected. From here you can connect another repo to this thread or **Remove** any previously connected repos.

![](/files/B8rAEY3RNa0K8OqXXE2p)

To manage this list in the future, go back to the **Apps** section of the group or thread and click the edit button next to GitHub.

![](/files/R6z6b49bf8P0aPjDNRer)

</details>

<details>

<summary>Choose which events on Pull Requests or Issues trigger a notification in Glue</summary>

Choose which events you want to receive messages for and then click **Next**.

![](/files/SazJKZ8AhTziYW0DgtVe)

If you're connecting a repo to a group, you'll be asked whether you want to send all updates to the group chat or create threads for each Issue, PR, etc.

![](/files/4hWswfanF7X8OYeIsaDq)

The repo you added will now appear in the list of repos connected to the group or thread you selected. From here you can connect another repo to this thread or **Remove** any previously connected repos.

![](/files/B8rAEY3RNa0K8OqXXE2p)

</details>

*\*Note that to add an app to a group, you must be a group admin or workspace admin. Anyone can add an app to a thread.*

### Setting up the GitHub Integration

<details>

<summary>Step 1: Add the GitHub app to your workspace</summary>

See instructions for [installing an app in your workspace.](/integrations/integrations-overview/add-integrations-to-your-glue-workspace.md#add-app-to-workspace)

</details>

<details>

<summary>Step 2: Authorize GitHub</summary>

Each user will need to authorize access to their GitHub account once. You will be prompted to authorize the first time you paste a Github link into a message.

* Paste a GitHub link into any message in Glue.
* A prompt will appear asking you to authorize Glue to access GitHub. Click **Authorize**.

</details>

### GitHub requirements

To use GitHub link previews, your organization needs:

1. **OAuth authentication**: Proper permissions to access GitHub data
2. **Team access**: Appropriate permissions to view the linked GitHub resources

### Troubleshooting

<details>

<summary>Link previews are not appearing</summary>

* Verify GitHub app is installed
* Check repository permissions
* Confirm you have access to the repository

</details>

<details>

<summary>I do not want my thread auto subscribed to app updates</summary>

* Just remove the link preview before sending and your thread will not be subscribed to updates.

</details>

<details>

<summary>App updates are not sending for a link I sent</summary>

* Make sure you include the rich link preview when you send the link to the thread. If you removed the link preview, the thread will not be subscribed.
* App udpates are only supported in threads, not in other chat types.

</details>

<details>

<summary>How do I unsubscribe my thread from an app update</summary>

* This is coming soon.

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.glue.ai/integrations/github.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
