Klaviyo App Platform Installation

Before you start

Review the following information before you install the Klaviyo app.

• Review the App Platform overview and key concepts to familiarize yourself with this tool before the installation.

• You need to have Administrator permission in order to complete the installation process.

Gather your Klaviyo credentials – both installation methods below need the same two values from your Klaviyo account:

• Private API Key: In Klaviyo, go to Settings → API Keys → Create Private API Key. The key needs at minimum:

  • Read access to Events, and Write access to, Lists, Profiles, and Subscriptions

• Received Email Metric ID: In Klaviyo, go to Analytics → Metrics, open the Received Email metric, and copy the ID from the URL (e.g. https://www.klaviyo.com/metrics/AbCdEf123 → the ID is AbCdEf123). This is used to fetch a Customer's email event history.

The Klaviyo integration authenticates with a private API key – no OAuth flow is required.

Install the Klaviyo app

There are two ways to install and configure Klaviyo. Installing in Gladly (Option A) is the recommended path for most customers – it requires no command-line tooling.

Option A — Install in Gladly (recommended)

1. In Gladly, go to Apps → Create Configuration.

2. Select Klaviyo from the list of available apps.

3. Fill in the configuration form:

4. Received Email Metric ID – the metric ID you gathered above.

5. Private API Key – your Klaviyo private API key.

6. Save and activate the configuration.

That's it – the configuration is live. Continue to Enable Klaviyo in Gladly Team below.

Option B — Install with the App Platform CLI (appcfg)

Use this method if you prefer to manage configurations from the command line. You'll need a technical resource who can run the appcfg CLI and has access to both your Gladly and Klaviyo instances.

1. Install the App Platform CLI Tool

Install the App Platform CLI (appcfg), which allows you to manage and configure all your App Platform apps. Follow the setup instructions here: Install appcfg.

2. Obtain Your Gladly API Credentials

You'll need the following to authenticate with your Gladly instance:

• Gladly Host:

  • us-1.gladly.com for Production

  • us-uat.gladly.qa for Sandbox

• Gladly User: The email of a Gladly user with Administrator or API User permissions

• Gladly API Token: A personal API token for the user above

To generate your token, follow Gladly's API Token documentation. Once you have these, set them as environment variables for convenience:

export GLADLY_APP_CFG_HOST="us-1.gladly.com"   # or us-uat.gladly.qa for Sandbox
export GLADLY_APP_CFG_USER="your.email@company.com"
export GLADLY_APP_CFG_TOKEN="your-api-token-here"

3. Create the Configuration

Run the following command to configure the app:

appcfg apps config create "gladly.com/klaviyo/v1.0.0" \
  --name "Klaviyo" \
  --config '{"receivedEmailMetricId": "<received_email_metric_id>"}' \
  --secrets '{"apiKey": "<klaviyo_private_api_key>"}'

Always install the latest available version of the app. You can check the latest version using appcfg apps list.

4. List Configurations to Get Your Configuration ID

appcfg apps config list --identifier "gladly.com/klaviyo/v1.0.0"

Note the CONFIG ID from the output – you'll need it for the next step.

5. Activate Your Configuration

appcfg apps config update <config-id> --activate

Enable Klaviyo in Gladly Team

Both the Klaviyo Card in Customer Details and the Unsubscribe from Marketing (Klaviyo) action in the + menu must be enabled by Gladly before they appear in the agent desktop. Once your configuration is active, reach out to Gladly Support to enable the Card and the action for your team.

Resources

For more details on configuration and credential structure, refer to the app-platform-examples repository. You can always clone it and adapt it to your needs.