Skip to content

Create and manage a KB API client

Use a KB API client to maintain support knowledge from another system. Choose scopes that match the integration's actual work.

Create a client

  1. Open Configuration > Support AI > API clients.
  2. Enter a name that identifies the system and owner.
  3. Select the required scopes. Read-only access starts with kb.read. Private or draft reading needs its own scope.
  4. Add write, structure, publication or access scopes only when the integration needs them.
  5. Choose Create client and store the displayed client secret securely on the integration server.

A writing client consumes one available Editor license. Read-only clients do not. A writing scope does not automatically grant draft reading or publication. Check the scope list in the API reference.

Use the client

Exchange the client ID and secret at the Support token endpoint using the client-credentials grant. Use the returned bearer token for the scoped KB API. Keep the client secret and access token out of browser code, articles and webhook logs.

Create articles as drafts. Use explicit review, publish and access operations when the client has those permissions. Send the current version for edits and use an idempotency key for supported create operations.

Maintain access

Edit scopes when the integration's purpose changes. Current tokens are revoked when scopes change. Rotate the secret after an authorized credential update. Disable an unused client to revoke access and release its writing license.

Check the result

Test the required read or draft write with fictional content. Test a denied scope too. Do not enable publication just to make a draft-edit integration work.