GitHub integration

GitHub is supported through the Mach5 connector framework. This page lists every supported operation and where it can be used.

Connection

Integration connection picker

  • Connector kind: github
  • Configuration: name, token_secret_ref, optional api_base_url, optional default_owner.

How to use this integration

For Axon concepts, safety classes, idempotency, and outcomes, see Axon workflows.

Axon

Axon is the controlled action path for connector reads, enrichments, and side effects. Use Axon when a workflow needs to call GitHub directly, enrich an investigation, or take an approved action. Invoke the connector kind github with the operation name and JSON input.

connector: github
operation: lookup_user
input: { ... }

Ingest Pipelines

Use ingest pipelines for operations exposed as sources. These operations can checkpoint and stream records into Mach5-managed data.

source.connector: github
source.operation: list_repository_events
source.config: { ... }

SQL

Use SQL for read operations exposed as table or scalar functions. Query the connector operation with JSON input and join the result with Mach5 data.

SELECT *
FROM connector_table('github', 'lookup_user', JSON '{}');

Supported operations

OperationWhat it doesAxonIngest PipelinesSQL
validateValidate GitHub credentials and API URL.———
lookup_userLookup a GitHub user by username.Yes—Yes
get_repositoryFetch GitHub repository metadata by owner and repo name.Yes—Yes
list_repository_eventsList recent public GitHub repository events with bounded pagination.—YesYes
poll_audit_log_pageFetch a durable caller-driven page of GitHub organization or enterprise audit log events.—Yes—
poll_workflow_runs_pageFetch a durable caller-driven page of GitHub Actions workflow runs for a repository.—Yes—
poll_security_alerts_pageFetch a durable caller-driven page of GitHub repository security alerts.—Yes—
poll_repository_events_pageFetch a caller-driven page of GitHub repository events with Link-header checkpointing.—Yes—
parse_webhook_payloadParse and normalize a GitHub webhook payload.Yes——
get_authenticated_userFetch authenticated GitHub user identity.Yes—Yes
list_user_orgsList organizations visible to the authenticated user or a named user.Yes—Yes
list_followersList followers for the authenticated or named user.Yes—Yes
list_followingList users followed by the authenticated or named user.Yes—Yes
get_organizationFetch GitHub organization metadata.Yes—Yes
list_org_membersList organization members with bounded pagination.Yes—Yes
list_outside_collaboratorsList organization outside collaborators.Yes—Yes
list_teamsList organization teams.Yes—Yes
get_team_by_slugFetch an organization team by slug.Yes—Yes
list_team_membersList members of an organization team.Yes—Yes
list_team_repositoriesList repositories associated with an organization team.Yes—Yes
list_org_repositoriesList repositories for an organization.Yes—Yes
list_user_repositoriesList repositories for a user.Yes—Yes
list_branchesList repository branches.Yes—Yes
list_tagsList repository tags.Yes—Yes
list_collaboratorsList repository collaborators.Yes—Yes
get_languagesFetch repository language byte counts.Yes—Yes
get_topicsFetch repository topics.Yes—Yes
list_commitsList repository commits.Yes—Yes
get_commitFetch a repository commit.Yes—Yes
get_refFetch a Git reference.Yes—Yes
list_refsList Git references.Yes—Yes
compare_commitsCompare two commits or refs.Yes—Yes
list_issuesList repository issues.Yes—Yes
get_issueFetch a repository issue.Yes—Yes
list_issue_commentsList issue comments.Yes—Yes
list_pull_requestsList repository pull requests.Yes—Yes
get_pull_requestFetch a repository pull request.Yes—Yes
list_pull_request_filesList files changed by a pull request.Yes—Yes
list_pull_request_reviewsList reviews for a pull request.Yes—Yes
list_releasesList repository releases.Yes—Yes
get_releaseFetch a repository release.Yes—Yes
list_workflowsList repository Actions workflows.Yes—Yes
list_workflow_runsList repository Actions workflow runs.Yes—Yes
list_workflow_jobsList jobs for a workflow run.Yes—Yes
list_artifactsList repository Actions artifacts.Yes—Yes
list_workflow_artifactsList repository Actions artifacts.Yes—Yes
list_deploymentsList repository deployments.Yes—Yes
list_environmentsList repository environments.Yes—Yes
update_environmentCreate or update a repository environment.Yes——
list_packagesList organization packages.Yes—Yes
get_packageFetch organization package metadata.Yes—Yes
delete_packageDelete an organization package.Yes——
list_code_scanning_alertsList repository code scanning alerts.Yes—Yes
list_secret_scanning_alertsList repository secret scanning alerts.Yes—Yes
list_dependabot_alertsList repository Dependabot alerts.Yes—Yes
list_security_advisoriesList repository security advisories.Yes—Yes
list_org_audit_logList organization audit log events.Yes—Yes
list_enterprise_audit_logList enterprise audit log events.Yes—Yes
list_hooksList repository webhooks.Yes—Yes
list_webhooksList repository webhooks.Yes—Yes
get_hookFetch repository webhook metadata.Yes—Yes
search_repositoriesBounded repository search.Yes—Yes
search_usersBounded user search.Yes—Yes
search_issuesBounded issue and pull request search.Yes—Yes
search_codeBounded code search.Yes—Yes
graphql_queryExecute a bounded read-only GitHub GraphQL query.Yes—Yes
graphql_readExecute a bounded read-only GitHub GraphQL query.Yes—Yes
create_repositoryCreate a repository for the authenticated user or an organization.Yes——
update_repositoryUpdate repository metadata.Yes——
create_issueCreate a repository issue.Yes——
update_issueUpdate a repository issue.Yes——
create_issue_commentCreate an issue comment.Yes——
comment_issueCreate an issue comment.Yes——
add_issue_labelsAdd labels to an issue.Yes——
label_issueAdd labels to an issue.Yes——
create_pull_requestCreate a repository pull request.Yes——
update_pull_requestUpdate a pull request.Yes——
merge_pull_requestMerge a pull request.Yes——
create_pull_request_reviewCreate a pull request review.Yes——
review_pull_requestCreate a pull request review.Yes——
comment_pull_requestCreate a pull request review comment.Yes——
create_releaseCreate a repository release.Yes——
update_releaseUpdate a repository release.Yes——
delete_releaseDelete a repository release.Yes——
rerun_workflow_runRerun a GitHub Actions workflow run.Yes——
cancel_workflow_runCancel a GitHub Actions workflow run.Yes——
create_repository_dispatchCreate a repository_dispatch event.Yes——
create_hookCreate a repository webhook.Yes——
create_webhookCreate a repository webhook.Yes——
update_hookUpdate a repository webhook.Yes——
update_webhookUpdate a repository webhook.Yes——
delete_hookDelete a repository webhook.Yes——
delete_webhookDelete a repository webhook.Yes——
ping_hookPing a repository webhook.Yes——
graphql_mutationExecute an approved GitHub GraphQL mutation.Yes——

Analytics Cookies

Help us understand website usage.

Necessary storage remembers your choice. With your consent, Mach5 also uses PostHog analytics to measure website traffic and interactions.

Change this anytime from Cookie Settings in the footer. Privacy Notice.