GitHub

Connect

Auth type: OAuth (oauth2). Click Connect and approve access on the provider's page. Appbricx runs the OAuth flow (signed single-use state, PKCE where the provider supports it), stores the tokens encrypted and refreshes them before they expire.

Scopes requested: reporead:user

OAuth needs an OAuth app: the platform's when the operator configured one, or your own (admin panel, Integrations, Configure). You can also bring your own credentials.

• In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
• For every project in a workspace: Workspace settings, Integrations.
• Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("github", "github_create_issue", {
    "repository": "<repository>",
    "title": "<title>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("GitHub answered", { output: res.output });
}

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "github-github-create-issue",
  name: "GitHub: Create Issue",
  description: "Calls GitHub when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("github", {
      "action": "github_create_issue",
      "repository": "<repository>",
      "title": "<title>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/github/github_create_issue" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"repository":"<repository>","title":"<title>"}}'

Actions

Env keys

When connected, these credential fields are exposed to the project's runtime as environment variables (GitHub API access (repos, issues, PRs).). Server keys never reach the browser.

Details

Id

github

Category

Developer tools

Tags

git, vcs, code, pull-request, issues

Package

@activepieces/piece-github@0.6.6

Tier

Built in