Config IDs

Generate and manage Config IDs to connect your applications to Hawcx

Overview

A Config ID is the credential that connects your application to Hawcx. It's scoped to a specific project and environment, and it's what you pass to the Hawcx SDK to initialize authentication.

Project settings showing the Config IDs card with a generated Config ID displayed

Generate a Config ID

  1. Open your project and go to Settings > Config IDs
  2. Ensure the correct environment is selected (Development or Production)
  3. Click Generate Config ID
  4. Give it a descriptive name (e.g., "iOS Test App")
  5. Select the Platform: Web, iOS, or Android
  6. Click Generate

The full Config ID is displayed once upon creation. Development Config IDs remain visible in the list afterward.

Development vs Production

DevelopmentProduction
Who can createAdmin or DeveloperProvisioned by the Hawcx team
ProvisioningInstantProvisioned by Hawcx on request
Use caseTesting, staging, local devLive user-facing apps

Moving to production

To go live, contact the Hawcx team to have your production environment provisioned. Once it's enabled, you generate production Config IDs the same way as in Development.

Revoke a Config ID

Revoking is permanent and immediately blocks all requests made with that Config ID.

  1. Find the Config ID in the list
  2. Click Revoke
  3. Confirm the action

Admins can revoke any Config ID in the organization. Developers can only revoke Config IDs they created.

Using Your Config ID

Pass the Config ID when initializing the Hawcx SDK:

// React
<HawcxProvider config={{ configId: 'your_config_id' }}>
// Vanilla JS
const client = createHawcxAuth({ configId: 'your_config_id' });
# Environment variable
VITE_HAWCX_CONFIG_ID=your_config_id

Base URL

Your Base URL sits right next to the Config ID on the same Project Settings page in the Admin Console — copy it from there.

The base URL is unique to your environment — there is no universal default. Backend SDKs take it directly; the Web SDK's apiBase defaults to production, so for a sandbox project set it explicitly (frontend apiBase, backend base URL) or your PoC will silently talk to production.

Next Steps

Last updated on