Skip to content

// GitHub + Flux

Issues become cards.

Connect GitHub to Flux via the REST API. Create cards from new issues, move them on PR merge, and keep your kanban board in sync with your repository. GitHub Actions handles the automation.

// How to connect
04 steps
01

Create a Flux API key

In Flux Settings, generate an API key with write scope. Store it as a GitHub Actions secret (e.g., FLUX_API_KEY) so your workflows can authenticate against the Flux REST API.

02

Set up a GitHub Action

Create a workflow YAML in .github/workflows that triggers on issue creation, PR merge, or any GitHub event. Use a curl step or an HTTP action to call the Flux API with your stored API key.

03

Map GitHub events to Flux cards

When a new issue opens, POST to /api/cards to create a Flux card with the issue title and body. When a PR merges, PATCH the linked card to move it to your Done column. Use GitHub context variables to populate card fields.

04

Link cards back to GitHub

Include the GitHub issue URL in the Flux card description or as a comment. This creates a bidirectional reference so your team can navigate between the issue tracker and the kanban board.

// FAQ
03 questions
01

Is there a native GitHub integration?

+

Flux does not have a native GitHub integration with OAuth buttons. You connect the two systems via the Flux REST API, called from GitHub Actions or GitHub webhooks. This approach gives you full control over which events create or update cards.

02

Can I update Flux cards when a PR merges?

+

Yes. Set up a GitHub Action that triggers on the pull_request merged event. In the action, send a PATCH request to the Flux API to move the associated card to your Done or Review column. You will need to store the card ID or look it up by title.

03

How do I handle GitHub webhooks without Actions?

+

You can point GitHub repository webhooks at a server that receives the event payload and calls the Flux API. This requires running a small receiver service. GitHub Actions is simpler for most teams because it runs on GitHub's infrastructure with no additional servers.

// Ship and track

Code to card, automated.

Flux REST API + GitHub Actions. Sync your repo with your board.