# GitHub

### What is GitHub integration in ZigiOps?

GitHub is a Git-based source code hosting and collaboration platform used for repository management, issue tracking, and DevOps workflows.

ZigiOps enables secure, agentless integration between GitHub and ITSM, DevOps, and enterprise systems. Using ZigiOps, GitHub issues and repository data can be synchronized with downstream platforms to support cross-team workflows and automated development-to-operations processes.

With ZigiOps, GitHub can:

* Synchronize issues with ITSM systems
* Trigger incident or ticket creation based on GitHub activity
* Support DevOps-to-ITSM collaboration workflows
* Integrate securely without custom scripts or plugins

### Which GitHub versions are supported?

Using a supported version is mandatory.

| Product | Supported Deployment Types | Supported Versions |
| ------- | -------------------------- | ------------------ |
| GitHub  | All                        | All                |

### Are there any environmental prerequisites for GitHub?

The environmental prerequisites for this product are listed below.

**Note:** Confirm the prerequisites of the corresponding integration template before continuing further, as some templates may not require all environmental prerequisites.

#### How do I create a Personal Access Token (API Key) in GitHub?

Authentication between GitHub and ZigiOps requires a **Personal Access Token (PAT)**.

**Steps:**

1. Log in to your GitHub account.
2. Navigate to <https://github.com/settings/tokens>.
3. Generate a **Personal Access Token**.
4. Store the token securely - it will be used in the connected system configuration.

### How do I connect GitHub to ZigiOps?

#### GitHub - Connected System Configuration

{% stepper %}
{% step %}
Log in to ZigiOps

Log in to your **ZigiOps** instance.
{% endstep %}

{% step %}
Add GitHub as a connected system

Navigate to **Connected Systems > Add New System > GitHub**.
{% endstep %}

{% step %}
Configure the connection parameters

Configure the following parameters:

**Server URL**\
Input the URL of your GitHub instance.\
Example: `https://api.github.com`

**Username**\
Input the username of the GitHub integration user.

**API Key**\
Input GitHub's personal access token for authentication against the GitHub API.

**Proxy Settings (optional)**\
Enables the usage of a proxy server if required.
{% endstep %}

{% step %}
Save the system

If the settings are correct, click **Save** to store the system.

Once saved, GitHub becomes available for use in ZigiOps integration templates.
{% endstep %}
{% endstepper %}

### What are the most common GitHub integration use cases?

#### Use case 1: Synchronizing ServiceNow incidents with GitHub issues

ZigiOps can automatically create GitHub issues from ServiceNow incidents, enabling seamless collaboration between ITSM and development teams.

#### Use case 2: DevOps-to-ITSM traceability

GitHub issues can be synchronized with ITSM platforms to maintain traceability between development tasks and operational incidents.

#### Use case 3: Automated cross-team workflows

By integrating GitHub with service management systems, ZigiOps enables automated workflows that reduce manual communication and improve resolution time.

### What integration templates are available for GitHub?

ZigiOps provides prebuilt integration templates for GitHub.

#### Related Templates

* ServiceNow incidents - GitHub issues

Each template includes:

* Predefined entity and field mappings
* Direction of synchronization
* Entity-specific logic and filters

Templates are documented individually in the **Integration Catalog**.

### Summary

The GitHub integration in ZigiOps enables:

* Secure, agentless connectivity to GitHub
* Support for all GitHub versions and deployment types
* Authentication using personal access tokens
* Optional proxy support
* Ready-to-use templates for DevOps and ITSM workflows


---

# 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.zigiwave.com/available-systems/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.
