# Integrate Spike with GitHub Workflows

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

## Overview

[GitHub Workflows](https://docs.github.com/en/actions/writing-workflows) allows you to create custom workflows that automate your software development processes. Whether it's building, testing, or deploying your code, GitHub Workflows streamlines your CI/CD pipeline and ensures your projects stay on track.

##

By integrating GitHub Workflows with Spike, you can receive real-time alerts for various workflow-related incidents, including:

* **Workflow Failures:** Alerts when a workflow run fails, helping you quickly identify and address issues in your CI/CD pipeline.
* **Job Failures:** Notifications for individual job failures within a workflow, allowing for targeted troubleshooting.
* **Run Time Exceeds:** Alerts when a workflow or job takes longer than expected, indicating potential performance bottlenecks.

This integration ensures that you’re promptly informed of any issues in your workflows, enabling fast response and resolution.

{% hint style="success" %}
Auto-resolution is supported for this integration. Spike will also automatically group repeated incidents and suppress alerts while incident is open.
{% endhint %}

## Set up instructions

**Step 1:** Create a GitHub Workflows integration and copy the unique webhook URL.

{% content-ref url="/pages/-Ln3rb4wLUFeI-OAPcmq" %}
[Create integration and service on our dashboard](/integrations-guideline/create-integration-and-service-on-dashboard.md)
{% endcontent-ref %}

**Step 2:**

{% tabs %}
{% tab title="Setup on GitHub" %}

* **1. Access Webhook Settings:**
  * Go to the Settings section of your repository and open the Webhooks settings. **Add a New Webhook:**
  * Click on Add webhook to create a new webhook.
  * Paste the copied webhook in the URL field.
  * Set the content type to **application/json**.
  * Choose the individual events you want to monitor, such as workflow runs or job completions.
    {% endtab %}
    {% endtabs %}


---

# 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.spike.sh/integrations-guideline/integrate-spike-with-github-workflows.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.