Generate API Key in Dataworkz

API keys authenticate external applications and services with Dataworkz programmatically.

Each key is named for tracking purposes and can be monitored, revoked, or deleted from the API Key Configuration page.

API keys are found under Dataworkz Config → API Key in the left navigation.

API Key List

The API Key Configuration page displays all keys generated in your environment in a table with the following columns:

Column	Description
API Key Name	The name assigned to the key when it was created — used for identifying and tracking API calls
Usage Count	The total number of API calls made using this key
Last Used At	The date and time the key was last used to make an API call
Revoked	Indicates whether the key has been revoked — N for active, Y for revoked
Disabled	Indicates whether the key has been disabled — N for enabled, Y for disabled
Actions	Delete the key permanently using the delete icon

You can search for a specific key by name using the search bar at the top of the page.

Generating a New API Key

Step 1: Click Add New API Key

Click the + Add new API key button in the top right corner of the API Key Configuration page.

The Generate API key dialog opens.

Step 2: Enter a Key Name

Enter a descriptive name in the API key name field. The name is used for tracking API calls and identifying which key was used for each request — for example, demo_key or production_integration.

Click Create token to generate the key, or Cancel to close the dialog without creating one.

Step 3: Copy the Token Value

Once the token is created, the Token created successfully screen displays the generated token value.

Click the copy icon next to the token value to copy it to your clipboard.

⚠️ Warning: This is the only time the token value will be displayed in full. Once you close this dialog, the token is encrypted and cannot be retrieved again. Copy and store it securely before clicking Close.

Click Close once you have saved the token value.

Verifying the New Key

After closing the dialog, the new key appears in the API Key Configuration list alongside any existing keys.

A newly created key will show:

• Usage Count of 0 — no API calls have been made yet

• Last Used At — blank until the key is first used

• Revoked — N

• Disabled — N

Managing API Keys

From the API Key Configuration page you can perform the following actions:

Delete a key — Click the red delete icon in the Actions column to permanently remove the key. Deleted keys cannot be recovered and any integrations using the key will lose access immediately.

⚠️ Warning: Deleting an API key is irreversible. Ensure no active integrations or services are using the key before deleting it. Any system relying on a deleted key will immediately lose the ability to authenticate with Dataworkz.

Important Notes

⚠️ Warning: Store API key token values securely immediately after generation. Dataworkz encrypts the token after it is displayed and it cannot be retrieved or viewed again. If a token is lost, you must generate a new key.

💡 Note: Use descriptive, purpose-specific names for API keys — for example, salesforce_integration or teams_connector — to make it easy to track which system is using each key and identify unusual usage patterns.

💡 Note: Monitor the Usage Count and Last Used At columns regularly to identify unused or potentially compromised keys. Keys that have not been used for an extended period should be reviewed and deleted if no longer needed.

💡 Note: If a key is suspected to be compromised, delete it immediately and generate a new key for the affected integration.