Skip to content

Add generic custom API connector with GitHub Actions#9

Draft
tanner-cherry-glean wants to merge 1 commit intomainfrom
custom-api-connector
Draft

Add generic custom API connector with GitHub Actions#9
tanner-cherry-glean wants to merge 1 commit intomainfrom
custom-api-connector

Conversation

@tanner-cherry-glean
Copy link
Copy Markdown

Description

  • Adds a generic custom connector (custom_api_connector/) that fetches data from any REST API endpoint with Bearer token auth and pushes documents to Glean via the Indexing API
  • All configuration (endpoint URL, field mappings, datasource settings) is driven by config.json — no code changes needed to adapt to a new API
  • Includes a GitHub Actions workflow (.github/workflows/custom_api_connector.yml) with daily cron schedule and manual dispatch support

How to use

  1. Edit custom_api_connector/config.json — set your API endpoint, field mappings, and datasource details
  2. Add three GitHub Secrets: GLEAN_DOMAIN, GLEAN_API_TOKEN, SOURCE_API_TOKEN
  3. The workflow runs daily at 2:00 AM UTC, or trigger manually from the Actions tab

Testing

  • Set up secrets and run workflow manually via workflow_dispatch
  • Verify documents appear in Glean after indexing
  • Test with a different source API by updating config.json

🤖 Generated by Glean Code Writer
📝 Chat link - https://app.glean.com/chat/592f63fc58a34028a158dd5498372289

A reusable connector that fetches data from any REST API endpoint
using Bearer token auth and pushes documents to Glean via the
Indexing API. Configurable via config.json for endpoint, field
mappings, and datasource settings.

Generated by Glean Code Writer
@tanner-cherry-glean tanner-cherry-glean added the glean-code-writer Modified by Glean Code Writer label Mar 31, 2026 — with glean-github-app-oauth
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

glean-code-writer Modified by Glean Code Writer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants