Connector guidesAPIs and applications

GitHub (Preview)

Preview GitHub source configuration for repository selection and managed API token references.

The GitHub connector has a preview source schema for repository-based API configuration. It belongs to APIs and applications in the connector guides and applications in the connector registry.

Preview

The schema is available for reference. Use this connector in a saved connection or QuickFlow only when your workspace lists it as enabled. The current saved-connection model supports PostgreSQL; preview schema availability does not enable GitHub execution.

PropertyValue
connector_idgithub
connector_typegithub
Schema directionSource
AvailabilityPreview

Configuration fields

FieldRequirement
base_urlRequired GitHub API base URL.
ownerRequired repository owner or organization.
repositoryRequired repository name.
schema_streamOptional stream/schema selector; defaults to an empty string.
token_refRequired secret reference containing namespace and key.

The example illustrates the preview configuration shape. Replace the API URL and repository identifiers with values appropriate to your system when the connector is enabled.

{
  "base_url": "https://github-api.example.com",
  "owner": "example-org",
  "repository": "analytics",
  "schema_stream": "",
  "token_ref": {
    "namespace": "developer-tools",
    "key": "github-token"
  }
}

Prepare credentials

Store a token with the required repository access in a Secret Vault. Select its namespace and key in configuration. Keep the token value out of connection descriptions and logs.

Before using the connector

Confirm workspace enablement and read the current property schema. Use the streams and sync modes advertised by that enabled release. The preview schema alone does not define which repository resources, pagination behavior or sync modes are supported at runtime.

GitHub source ingestion is separate from Git integrations for pipeline projects, which bind repository code to workflow definitions.

Return to connector guides or use PostgreSQL for the currently supported saved-connection workflow.

Vegalake, VegaDB and VegaFlow are trademarks or registered trademarks of Vegalake Inc.

On this page