GitHub

Developer tools OAuth, or a personal access token Windmill docs

Open issues, review and merge pull requests, commit files and dispatch Actions workflows from any Windmill script, flow or app.

What you can do with GitHub

Complete, deployable projects built around GitHub — the fastest way to get something real running.

Set up in 2 steps

1

Connect from the Resources page

Open Resources, click Add a resource/API, pick github under Instance-configured OAuth APIs and click Connect. Windmill asks for the repo and workflow scopes; tick gist, project or read:org in the dialog if you need those scripts.

2

Run your first script

Fork any script below and run it against one of your repositories.

Scripts

Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.

Submit a script →

Flows

Multi-step workflows that already wire GitHub to something else.

All flows →

Trigger flows from GitHub

GitHub is not only a destination. These inbound paths are supported today.

GitHub events (native GitHub trigger)

Connect GitHub once under Workspace settings > Integrations, then add a GitHub trigger on a script or flow and pick a repository and events (push, pull_request, issues…). Windmill creates the repository webhook, which needs admin rights on the repository, and starts a run on every delivery.

Webhooks you manage yourself

To use a webhook you configured by hand, point it at a flow's webhook URL and verify the X-Hub-Signature-256 header against your webhook secret.

Resource types

The credential shapes the scripts on this page expect — pick the one your script asks for.

FieldTypeRequiredWhat it is
tokenstringYes
FieldTypeRequiredWhat it is
app_idstringYes
private_keystringYes
installation_idstringNo

Questions

OAuth or a personal access token?

OAuth is one click and its token does not expire. A personal access token suits scripted setup or a token limited to fewer repositories. Both act as the account that created them.

There is no Connect button on my instance

An instance admin has to add a GitHub OAuth app once, under Instance settings → Auth/OAuth/SAML → OAuth, before the tile appears. Until then, paste a personal access token in a github resource.