Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our Klaviyo Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Connecting to Klaviyo

To connect to Klaviyo, first choose an authentication method by setting the following property:

AuthScheme: The type of authentication to use whe connecting to Klaviyo.

Depending on the selected method, additional connection properties are required. See below for configuration steps for each supported authentication type.

Accessing Custom Fields

By default, the cmdlet surfaces only system fields. To detect and include custom fields set IncludeCustomFields to true. When IncludeCustomFields is set to true the cmdlet scans RowScanDepth records to detect custom fields and determine their datatype. Set RowScanDepth to 0 to scan all records for custom field detection. Note that enabling custom fields and setting RowScanDepth to 0 or a large value may affect performance.

Accessing List_{ListName} and Segment_{SegmentName} as separate views

By default, the cmdlet surfaces only the system tables and Views. To model each List and Segment as a separate view, similar to the Klaviyo interface, set ListDynamicViews to true.

Authenticating to Klaviyo

You can authenticate to Klaviyo using either an API Key or OAuth PKCE.

API Key

First, generate an API Key, if you have not done so already:

Log in to your user account.
Navigate to the Private API Key creation page.
Click Create Private API Key.
Under Private API Key Name, assign a name to the key.
Under Select Access Level, choose the required access level. At minimum, Accounts: Read access is required for a successful Test Connection.
Click Create to generate the API Key. Copy and save the generated API Key, as it is only shown once.

Next, set the following properties:

AuthScheme: Set this to APIKey.
APIKey: Set this to the value of the Private API Key that you generated.

OAuth PKCE

Set AuthScheme to OAuthPKCE.

Desktop Applications

To authenticate using OAuth PKCE you must create a custom OAuth application. See Creating a Custom OAuth App for instructions.

Get and Refresh the OAuth Access Token

After setting the following properties, you are ready to connect:

OAuthClientId Set this to the client Id assigned when you registered your app.
OAuthClientSecret Set this to the client secret assigned when you registered your app. This is optional if a secret was not generated during app registration.
CallbackURL Set this to the redirect URI defined when you registered your app. For example: http://localhost:3333

When you connect, the cmdlet opens Klaviyo's OAuth endpoint in your default browser. Log in and grant permissions to the application.

The cmdlet refreshes the access token automatically when it expires.

Headless Machines

To configure the cmdlet, use OAuth with a user account on a headless machine. You need to authenticate on another device that has an internet browser.

Choose one of two options:
- Option 1: Obtain the OAuthVerifier and PKCEVerifier values as described in "Obtain and Exchange a Verifier Code" below.
- Option 2: Install the cmdlet on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.
Then configure the cmdlet to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange Verifier Codes

To obtain a verifier code and PKCE verifier, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

Choose one of these options:
- If you are using the Embedded OAuth Application, call the GetOAuthAuthorizationURL stored procedure. Open the URL returned by the stored procedure in a browser.
- If you are using a custom OAuth application, set the following properties:
  - InitiateOAuth: Set to OFF.
  - OAuthClientId: Set to the client Id assigned when you registered your application.
  - OAuthClientSecret: Set to the client secret assigned when you registered your application. This is optional if a secret was not generated during app registration.
  Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. The stored procedure returns the URL to the OAuth endpoint as well as a PKCEVerifier value. Note this value for later use. Open the URL returned by the stored procedure in a browser.
Log in and grant permissions to the cmdlet. You are redirected to the redirect URI.

There is a parameter named code appended to the redirect URI. Note the value of this parameter. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

InitiateOAuth: Set this to REFRESH.
OAuthVerifier: Set this to the noted verifier code (the value of the code parameter in the redirect URI).
PKCEVerifier: Set this to the value you noted earlier in Step 1.
OAuthClientId: (custom applications only) Set this to the client Id in your custom OAuth application settings.
OAuthClientSecret: (custom applications only) Set this to the client secret in the custom OAuth application settings. This is optional if a secret was not generated during app registration.
OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

Test the connection to generate the OAuth settings file, then re-set the following properties to connect:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application. This is optional if a secret was not generated during app registration.
OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the cmdlet to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to install and create a connection with the cmdlet on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application. This is optional if a secret was not generated during app registration.
OAuthSettingsLocation: Set this to the location of the OAuth settings file you copied from the machine with the browser. Make sure this location gives read and write permissions to the cmdlet to enable the automatic refreshing of the access token.

Creating a Connection Object

You can then use the Connect-Klaviyo cmdlet to create a connection object that can be passed to other cmdlets:

$conn = Connect-Klaviyo -AuthScheme "OAuthPKCE" -InitiateOAuth "GETANDREFRESH" -OAuthClientId "myClientId" -OAuthClientSecret "myClientSecret" -CallbackURL "http://localhost:33333"

Retrieving Data

The Select-Klaviyo cmdlet provides a native PowerShell interface for retrieving data:

$results = Select-Klaviyo -Connection $conn -Table "SampleTable_1" -Columns @("Id, Column1") -Where "Column2='Bob'"

The Invoke-Klaviyo cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file:

Select-Klaviyo -Connection $conn -Table SampleTable_1 -Where "Column2 = 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\mySampleTable_1Data.csv -NoTypeInformation

You will notice that we piped the results from Select-Klaviyo into a Select-Object cmdlet and excluded some properties before piping them into an Export-CSV cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each row object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON:

 
PS C:\> $conn  = Connect-Klaviyo -AuthScheme "OAuthPKCE" -InitiateOAuth "GETANDREFRESH" -OAuthClientId "myClientId" -OAuthClientSecret "myClientSecret" -CallbackURL "http://localhost:33333" 
PS C:\> $row = Select-Klaviyo -Connection $conn -Table "SampleTable_1" -Columns (Id, Column1) -Where "Column2 = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "SampleTable_1",
  "Columns":  [

  ],
  "Id":  "MyId",
  "Column1":  "MyColumn1"
}

Deleting Data

The following line deletes any records that match the criteria:

Select-Klaviyo -Connection $conn -Table SampleTable_1 -Where "Column2 = 'Bob'" | Remove-Klaviyo

Modifying Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Klaviyo, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MySampleTable_1Updates.csv | %{
  $record = Select-Klaviyo -Connection $conn -Table SampleTable_1 -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Klaviyo -Connection $conn -Table SampleTable_1 -Columns @("Id","Column1") -Values @($_.Id, $_.Column1) -Where "Id  = `'$_.Id`'"
  }else{
    Add-Klaviyo -Connection $conn -Table SampleTable_1 -Columns @("Id","Column1") -Values @($_.Id, $_.Column1)
  }
}

Cmdlets for Klaviyo