API keys

Mint keys, connect tools, and enable API writes for your community.

Settings → API/MCP is where you create API keys and connect external tools (including LLM agents) to JOGL Network. This page is the admin-facing companion to the developer Authentication reference.

Connect a client

The Connect a client panel gives you the MCP server endpoint — the branded https://my.jogl.network/mcp URL, used in the one-click sign-in steps and the API-key snippets alike — with a step for Claude Code, Claude Desktop, Codex, Cursor and other MCP clients. Most clients need only that URL: you sign in to JOGL once in the browser, with no API key. For a client without browser sign-in, Connect with an API key instead gives the snippet for a key. The panel falls back to the raw Supabase functions URL only on preview or local builds, where no branded host exists; that URL still works with an API key anywhere.

Create a key

Create keys with a scope tier:

  • Read — search:read, profile:read, enrich:read, history:read.
  • Read + Write — adds member:write, enrich:write, community:write, which creates communities you own and pay for (your free trial or plan must cover them), and crm:write, which maps and runs the syncs of the CRMs connected to communities you manage (it never sees or enters a CRM key).

An Advanced expander exposes granular scopes, including those that act for you and that neither tier includes: self:enrich, which starts a billable run on your own profile, contact:write, which sends members direct messages in JOGL and asks attendees of events you attend for meetings, under your name, each one previewed before it is sent, notes:read and notes:write, which read and add the private notes you keep on the people you can see in JOGL, and settings:write, which changes some of your own settings as you (who can see your profile, who can message you or send you connection requests, the emails JOGL sends you, and turning on the use of your notes as context). A note in which AI structuring marked a detail as sensitive is withheld from notes:read, but a note never run through AI structuring is returned as you wrote it; the page says so when you tick either one, and says what settings:write can change when you tick it. Keys are personal (minted by you, for you — organization-owned keys can no longer be created) and the secret is shown once at creation. The key's rate-limit tier is fixed when it is minted (an OAuth connector's follows your account instead); see rate limits.

You can create keys in live or test environments, but read what "test" means here carefully.

A test key is not a sandbox. The choice changes the secret's prefix (jogl_test_ instead of jogl_live_) and how the key is labelled — nothing else. A test key reads and writes your real data, through the same endpoints, with the scopes you gave it. There is no separate sandbox it routes to, and it isolates nothing. Treat a test key with write scopes exactly as carefully as a live one.

Enabling write access

Read keys work immediately. A key with contact:write sends only while Write access below is on for its owner's personal account: turning it off stops that person's own keys and connected apps from sending messages and meeting requests, in every community. An organization's switch stops no sends, since only a person's own keys and apps send. Whether a member accepts a message follows their own message settings, and whether an attendee can be asked for a meeting follows the event, as in the app; a block between you and them, made by either of you, refuses both.

Write keys additionally need Write access to be on for the account that pays for the community they write to. You hold that switch for your personal account and for each organization you own or administer. It is on by default; turn it off there to stop API writes to the communities that account pays for, whoever's key or AI tool makes them. It does not stop your keys writing to a community another account pays for, where that account's switch decides. Your personal account's switch also stops your own keys and AI tools sending, in every community:

  • Turning it back on records a versioned write attestation and flips the account's write flag on.
  • It covers the owner's own keys and AI tools, and the admins' below. A community's admins can also write through the API (add members, erase a member's data from the community, start enrichment) unless its owner turns off Admins can write through the API in the API & AI tools section of that community's admin dashboard, or the same switch under Write access → Community admins. That switch is on by default. It is for admins who do not control the community's billing owner: the owners and admins of the organization that pays for a community act as its owner while they hold one of the organization's seats, and need only the owner's write access. If the owner's write access is off, turning that switch back on asks for the attestation and turns write access on too. Spend is billed to the community's owner.

A Connected apps section lists the OAuth (WorkOS) connectors that have been granted access. A connector you approve gets full access: its consent screen lists what it can read, the changes it can make and the write attestation, and Allow accepts that attestation for your personal account, which turns write access on for that account. A connector approved on a screen that lists sending members messages and meeting requests, as every screen has since that permission was added, can also send members messages and ask attendees for meetings as you, each previewed before it is sent, as a key with contact:write does; one approved on an earlier screen cannot, and a reconnect may keep the original approval. The same goes for your private notes: a connector approved on a screen that lists reading and adding them can read them and, while write is on for it, add notes as you; one approved on an earlier screen cannot. A connector made before CRM syncs were added cannot run them either, and one approved on a screen that did not list changing your own settings cannot change them. Such a connector's card offers Add new permissions: it lists what the connector would gain, worded as on the consent screen, and adds it to that connector once you approve (sending, adding notes, changing your settings and running CRM syncs only while write is on for it). Its client sees the new tools the next time it lists its tools, usually in a new conversation. Revoking the connector here and connecting the client again also works. Turn write off on a connector here to make it read-only: that also stops it sending, adding notes and changing your settings, though it can still read your notes. A connector approved before, or in the hour after, full access became the default stays read-only until you turn write on, which asks you to accept the attestation if your account has not. Either way, each write is still checked against the community it targets, as above. When just-in-time write consent is switched on for your account, an API write requests section also appears here, listing write requests waiting for your approval.

Enabling write access authorizes automated changes to your communities' data. Only enable it for keys and connectors you trust, and revoke anything you're unsure about — revocation takes effect on the next request. What stops a key is revocation, or the expiry it was given when it was minted — and keys created here are minted without one, so revocation is the only stop a key from this page has. For a connected app, revoking it here is the only stop short of deleting your account, which revokes the keys you own and every connected app that has been used, but not a key an organization owns or an app authorized and not used yet, as Privacy & GDPR explains.

Sur cette page