How to use the new Workspace API key?

Introducing Workspace-specific API keys

On 2022 October 10, we introduced a new system for managing API access to Playvox Customer AI.

Previously, API keys were tied to individual users. This caused data synchronization issues when users left the organization or were removed from their Customer AI workspace. The API connection would be severed when the user is removed from the workspace, and the data would stop syncing, causing disruption to reporting.

To avoid this issue, we have transitioned to using Workspace-specific API keys. This means that when a user connects Customer AI to a support CRM such as Zendesk or builds an API connection to import interactions into Customer AI, the connection would be tied to the Workspace rather than the individual user. This means that even if the user were to leave the Workspace, the data connection would stay uninterrupted.

Update your integrations to use the new API Key

For more than six months, we have been supporting the deprecated User-specific API Keys to avoid disruption to our customers. Since most customers have already migrated to using Workspace-specific API Keys, we have decided to deprecate user-facing API Keys.

Support CRMs - no action required

No action is necessary if you are using our direct Support CRM integrations such as Intercom, Zendesk, and Freshdesk. We have already automatically migrated to use the new Workspace-specific API Keys behind the scenes.

Reviews - no action required

No action is necessary if you are using one of our Online Reviews integrations, such as Trustpilot, App Store, and Google Play Store. We have already automatically migrated to use the new Workspace-specific API Keys behind the scenes.

Zapier - action required

If you have configured your Zapier integration before 2022 October 10, you will need to update your Zapier Connector credentials in order to continue synchronizing data between Zapier and Customer AI.

Please follow the below steps to update your Zapier integration:

  1. Login to Playvox Customer AI and head to Integrations

  2. Under the API Key section, click the Reveal button. Your new API Key will appear.

    Copy the API Key
  3. Copy the API key to your clipboard.
  4. Login to Zapier
  5. Navigate to My Apps

  6. Locate the Playvox Customer AI connector and click on it

    My Apps

  7. Select a connection tied to your active Zaps, tap on the [...] button, and then, Reconnect

    Reconnect
  8. In the pop-up window, paste the API Key you copied in Step 3.
  9. Click Yes, Continue to Playvox Customer AI to complete the connection.

Your Zapier Zaps should now run using your new Workspace-specific API Key.

API - action required

If you are using our API to interact with Customer AI programmatically and you have configured your credentials before 2022 October 10, you will need to update your integration to use the new API key.

In order to retrieve your API Key please follow these steps:

  1. Login to Playvox Customer AI and head to Integrations

  2. Under the API Key section, click the Reveal button. Your new API Key will appear.

    Copy the API Key
  3. Copy the API key to your clipboard.
  4. Update your API integration credentials to use the new API Key.

Please refer to our API Documentation for more details: https://playvoxcustomerai.docs.apiary.io/