OAuth connectors

OAuth connectors let users authorize your app to access their accounts in external services. Sixb handles authorization, account selection, and token refresh.

Configure a connector

Export an OAuth connector from connectors/. Follow its package README for the provider credentials and scopes. For example:

import { defineConnector } from "@sixb/core"
import { linkedin } from "@sixb/connector-linkedin"

export const linkedinAds = defineConnector("linkedin-ads", linkedin({
  clientId: process.env.LINKEDIN_CLIENT_ID!,
  clientSecret: process.env.LINKEDIN_CLIENT_SECRET!,
  accountType: "ad-account",
  scopes: ["r_ads", "r_ads_reporting"],
}))

TXT

https://<sixb-api-origin>/auth/connectors/callback

With persistent storage, set connectorConnections.encryptionKey in your createSixb() config:

connectorConnections: {
  encryptionKey: process.env.SIXB_CONNECTOR_ENCRYPTION_KEY!,
},

Generate the key once and store it as a deployment secret. Keep the same key across restarts and all processes sharing the database. Losing or replacing it makes existing credentials unreadable.

BASH

bun -e 'import { randomBytes } from "node:crypto"; console.log(randomBytes(32).toString("base64url"))'

Connect an account

Use useConnectorConnection in your app to start authorization and let the user choose an account. The user must be signed in with a role that grants can.manage(linkedinAds).

TSX

import { useConnectorConnection } from "@sixb/client/hooks"

export function ConnectLinkedIn() {
  const linkedin = useConnectorConnection({
    connectorId: "linkedin-ads",
    slot: "marketing",
  })

  return (
    <>
      <button onClick={linkedin.connect} disabled={!linkedin.canConnect}>
        {linkedin.connection?.account.label ?? "Connect LinkedIn"}
      </button>

      {linkedin.status === "selecting_account" &&
        linkedin.accounts.map((account) => (
          <button key={account.id} onClick={() => linkedin.selectAccount(account.id)}>
            {account.label}
          </button>
        ))}
    </>
  )
}

slot names how your app uses the account, such as marketing or customer-support. Keep this component mounted on the page users return to after authorization so the hook can resume account selection. The hook also exposes disconnect() and error for your interface.

Use the account

In backend code, pass the connector and the same slot to get its authenticated client:

import { linkedinAds } from "./connectors/linkedin"

const client = await sixb.connector(linkedinAds, {
  owner: { type: "project" },
  slot: "marketing",
})

Syncs read all connected accounts automatically, so you don't need to select a slot in a sync definition.

OAuth connectors

Configure a connector

Connect an account

Use the account

Search docs