Set up accounts and connectors

Connectors let workflows use apps and APIs through configured accounts, OAuth grants, provider keys, and local secrets.

For model keys and routing, see Add model providers.

Before You Start

Decide what the workflow needs:

Add A Connector Account

  1. Open settings.
  2. Go to connectors.
  3. Choose the connector.
  4. Add or select an OAuth app configuration if required.
  5. Start account authorization.
  6. Complete the provider authorization flow.
  7. Confirm the account appears as connected.
  8. Run a smoke check when the connector provides one.

Add Provider Keys And Secrets

  1. Open settings.
  2. Go to secrets or provider settings.
  3. Add the key or token.
  4. Give it a clear name.
  5. Choose kind and provider.
  6. Save it to the local secret registry.
  7. Check status.

Secret values are write-only. Aegis stores metadata and redacted previews separately from local secret material.

Use Connectors In Workflows

  1. Open the workflow designer.
  2. Add a connector tool node or configure an agent node with connector tools.
  3. Select the account.
  4. Choose the operation.
  5. Fill in required inputs.
  6. Confirm scopes and approval policy.
  7. Save and test with safe data.

Connector Write Operations

Prefer typed connector operations for side effects. For example, use gmail.create-draft for Gmail drafts instead of a raw Gmail API request, because typed tools can name their purpose, required scopes, policy class, and output receipt.

Generic OAuth request tools such as github.api-request, google-sheets.api-request, or stripe.api-request are advanced escape hatches. They are useful while building a typed connector operation, but they should not be the default workflow surface.

Unsafe generic OAuth methods (POST, PUT, PATCH, and DELETE) require an approvalPreview that matches the connector id, method, path, and account id before the request can run. The preview summary should describe the intended side effect in operator-readable language. If the preview does not match the actual request, Aegis blocks the call before reading OAuth tokens or contacting the provider.

When adding connector writes:

Use Connectors In Dashboard Components

Dashboard components can use connector-backed data for views such as Planner, calendar context, source refreshes, and notifications. Configure the account first, then select it in the component or settings panel.

Current Catalog Coverage

The current OAuth catalog covers Google Workspace, GitHub, GitLab, Jira, Linear, Slack, Discord, Microsoft Teams, Microsoft Excel, Notion, Calendly, Zoom, Stripe, PayPal, Shopify, Mailchimp, Bitly, LinkedIn, Facebook, Instagram, WhatsApp, Twitter / X, Spotify, Strava, and YouTube. Apple Developer and Plaid have dedicated app configuration surfaces.

For the full connector and tool inventory, see Capability Inventory.