---
title: "POST /workflows/github/install"
method: POST
path: "/workflows/github/install"
tags: ["workflows"]
---

# POST /workflows/github/install

`POST /workflows/github/install`

Handle the installation of our GitHub app onto a repository or organization.

## Headers

- `X-GitHub-Delivery` string, required

## Request body

- InstallationRepositoriesPayload — A model for a GitHub webhook installation event
  - `installation` Installation, required — The GitHub App installation
    - `id` integer, required — The installation ID
  - `repository` WebhookRepository — The repository where the GitHub webhook event occurred
    - `full_name` string, required — Full name of the GitHub repository
  - `sender` Sender, required — The user that triggered the event
    - `login` string, required — GitHub username of the sender of the GitHub webhook event
  - `action` string, required — The action which the event describes
  - `repositories_added` WebhookRepository[], required — An array of repository objects, which were added to the installation
    - `full_name` string, required — Full name of the GitHub repository
  - `repositories_removed` WebhookRepository[], required — An array of repository objects, which were removed from the installation
    - `full_name` string, required — Full name of the GitHub repository

## Other responses

- `418` — This code tells AWS Lambda not to retry.

---

[API](https://skmtc.net/dockstore/apis/dockstore-api.md) · [All operations](https://skmtc.net/dockstore/apis/dockstore-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dockstore/dockstore-api/versions/9d82a4e96aa7/schema)