Skip to main content
API keys are used to authenticate with the VozAgent API. You need them when connecting VozAgent to platforms like Zapier, building custom integrations, or accessing VozAgent data programmatically. The API Keys tab in the Integrations page is where you create, view, and delete your keys.

​
What Are API Keys?

An API key is a secret token that identifies your VozAgent account when making API requests. Think of it like a password for your applications — any system that has your API key can access your VozAgent data on your behalf. API keys are used for:
  • Zapier integration — when you connect VozAgent as an app in Zapier, you enter your API key to authenticate
  • Custom automations — if you build your own tools that interact with VozAgent
  • Third-party platforms — any service that integrates with VozAgent via its API
All API keys start with the prefix gw_ so you can easily identify them.

​
Getting to API Keys

  1. Go to Integrations in your sidebar
  2. Click the API Keys tab at the top of the page
If you don’t have any API keys yet, you’ll see an empty state with the message “No API Keys Yet” and a prompt to create your first one.

​
Creating an API Key

  1. Click the Create API Key button (or Create New API Key if you already have existing keys)
  2. In the dialog that appears, fill in the following:
    • Name (required) — a descriptive name so you can identify what this key is used for (for example, “Production API Key” or “Zapier Integration”)
    • Description (optional) — additional details about what this key is used for
  3. Click Create API Key

​
After Creation

Once the key is created, a dialog appears showing your new API key. This is the only time you will see the full key. Important: Copy your API key immediately. For security reasons, VozAgent does not store the full key and you will not be able to view it again after closing this dialog. If you lose your key, you will need to create a new one. Click the copy button next to the key to copy it to your clipboard. A confirmation message appears when the copy is successful. When you’re done, click Done to close the dialog.

​
Viewing Your API Keys

All your API keys are displayed in a table with the following columns:
ColumnDescription
NameThe name you gave the key, with the description shown below it (if provided)
KeyA masked preview of the key showing gw_ followed by dots and the last few characters
CreatedThe date the key was created
ActionsCopy and delete buttons
The key preview shows enough characters to help you identify which key is which, without exposing the full key.

​
Copying a Key Preview

Click the copy icon in the Actions column to copy the masked key preview to your clipboard. Note that this copies only the masked version (gw_ followed by dots and the last few characters) — not the full key. The full key is only available at the moment of creation.

​
Deleting an API Key

To delete an API key:
  1. Click the trash icon in the Actions column next to the key you want to remove
  2. A confirmation dialog appears showing the key name
  3. Click Delete to confirm
Warning: Deleting an API key is permanent and takes effect immediately. Any application or integration using that key will lose access to the VozAgent API. Make sure to update any systems using the key before deleting it.

​
Security Best Practices

​
Keep Your Keys Secret

  • Never share API keys publicly — do not post them in public repositories, forums, or documentation
  • Never include API keys in client-side code — keys should only be used in server-side applications or secure environments
  • Store keys securely — use environment variables or a secrets manager, not plain text files

​
Use Descriptive Names

Give each key a clear name and description so you know exactly what it’s for. For example:
  • “Zapier Production” — for your live Zapier integration
  • “Development Testing” — for testing during development
  • “WordPress Plugin” — for a custom WordPress integration
This makes it easy to identify which key to revoke if one is compromised.

​
Create Separate Keys for Different Uses

Create a separate API key for each application or integration. This way, if one key is compromised, you can revoke it without disrupting other integrations.

​
Rotate Keys Periodically

Consider deleting old keys and creating new ones periodically, especially if team members who had access leave your organization.

​
Using API Keys with Zapier

When setting up the VozAgent integration in Zapier:
  1. Go to Zapier and create a new Zap
  2. Search for VozAgent as your trigger or action app
  3. When prompted to connect your account, enter your VozAgent API key
  4. Zapier will verify the key and connect to your account
For more details on the Zapier integration, see the Zapier integration page in your VozAgent dashboard at Integrations > Third Parties > Zapier.

​
Troubleshooting

“Authentication failed” errors — Make sure you’re using the full API key (not the masked preview). The full key is only shown once at creation. If you’ve lost it, create a new key. API key not working after creation — Verify you copied the key correctly with no extra spaces. Try creating a new key if the issue persists. Need to revoke access — Delete the compromised key immediately from the API Keys tab. Create a new key and update your applications with the new one. Forgot which key goes where — This is why descriptive names matter. If you’re unsure, create a new key with a clear name and update the application, then delete the old unknown key.