Klaviyo Pipe
Manage your Klaviyo marketing through your Tadabase app. Use the Klaviyo API to create and manage lists, segments, profiles, and campaigns.
Getting Started
Prerequisites:
-
- A Klaviyo account
In order to use Klaviyo with Tadabase, it is necessary to have a Klaviyo account. If you do not have one, you can create a Klaviyo account at https://www.klaviyo.com/.
Install the Klaviyo Pipe
2. You will then be prompted to enter your Klaviyo Private and Public API Keys. See below for more information on how to find your Klaviyo API Keys.
Obtaining Your Klaviyo API Keys
To manage API keys, you must have an Owner, Admin, or Manager role on the account:
1. Log in to your Klaviyo account here.
2. You can obtain and make changes to your API keys from your account's Settings page under the API Keys tab.
- Obtain both your Public and Private API keys. Generate your Private API Key by clicking on the 'Create Private API Key' button.
- To learn more about Klaviyo API Keys go to Klaviyo's Obtain API Credentials Documentation.
Excellent! After inserting your Public and Private API Keys into the pop-up window, you are now ready to click 'Install' and start using the Klaviyo Pipe.
Global Parameters
There are two Global Parameters in this pipe. The default values for these parameters are automatically set when you install the pipe. You can change these values at any time in the Global Parameters tab of your installed Klaviyo pipe.
- Private API Key - You can generate a Private Klaviyo API Key in the API Keys tab in your account's Settings page.
- Public API Key - Your Public Klaviyo API Key gets generated in the API Keys tab in your account's Settings page when you create a Klaviyo account.
All API calls below must contain the authorization details in the global parameters.
API Calls
- Track Profile Activity
- Identify Profile with an Email Address
- Create a List
- Get Lists
- Get a Specific List's Info
- Update List Name
- Delete List
- Add Profiles to a List
- Subscribe Profiles to a List
- Unsubscribe and Remove Profile From List Using an Email Address
- Get Metrics Info
- Get Events for All Metrics
- Get Events for a Specific Metric
- Get Profile ID with an Email Address
- Identify Profile with a Phone Number
- Unsubscribe and Remove Profile From List Using a Phone Number
- Check if Profiles Are in a List Using an Email
- Check if Profiles Are in a List Using a Phone Number
- Check if Profiles Are in a List and Not Suppressed (Using an Email)
- Check if Profiles Are in a List and Not Suppressed (Using a Phone Number)
- Get Global Exclusions and Unsubscribes
- Exclude Profile from All Email
- Get All Exclusions for a List
- Get List Members
- Create New Template
- Update Template
- Get All Templates
- Delete Template
- Clone Template
- Render Template
- Create New Campaign
- Get Campaigns
- Get a Specific Campaign's Info
- Update Campaign
- Send a Campaign Immediately
- Schedule a Campaign
- Cancel a Campaign
- Clone a Campaign
- Get Campaign Recipients
- Get Segments
- Get a Specific Segment
- Update a Segment
- Get Segment Profiles
- Get Segment Members
- Check if Profiles Are in a Segment Using an Email
- Check if Profiles Are in a Segment Using a Phone Number
Track Profile Activity
For more details and examples, go to the Klaviyo API Documentation - Track Profile Activity
Parameters
- Event* - Name of the event you want to track.
- Email* - Customer's email address.
- Item Name - Enter the 2 letter state code. (Optional)
- Value - A numeric value to associate with this event (for example: the dollar value of a purchase).
*Required
Response
- Success - if the tracking was successful, this will be 1, if it fails it will be 0.
Identify Profile with an Email Address
For more details and examples, go to the Klaviyo API Documentation - Identify Profile with an Email Address
Parameters
- Email Address* - Specify the email address of the profile you would like to identify.
*Required
Response
- Success - if the identification was successful, this will be 1, if it fails it will be 0.
Create a List
For more details and examples, go to the Klaviyo API Documentation - Create List
Parameters
- List Name* - Specify what name you would like to call your list.
*Required
Response
- List ID
Get Lists
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get Lists
Parameters
- No Parameters
Response
- Lists (array)
Get a Specific List's Info
For more details and examples, go to the Klaviyo API Documentation - Get List Info
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
*Required
Response
- List Name
- Folder Name
- Created
- Updated
Update List Name
For more details and examples, go to the Klaviyo API Documentation - Update List Name
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
- Updated List Name*
*Required
Response
- Empty Response
Delete List
For more details and examples, go to the Klaviyo API Documentation - Delete List
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
*Required
Response
- Empty Response - If the deletion was successful, you should receive a success message 200.
Add Profiles to a List
For more details and examples, go to the Klaviyo API Documentation - Add Profiles to a List
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
- Email*
- Phone Number* - Example: +18181234567
- First Name
- Last Name
*Required
Response
- Profile ID
Subscribe Profiles to a List
For more details and examples, go to the Klaviyo API Documentation - Subscribe Profiles to a List
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
- Email*
- Phone Number* - Example: +18181234567
- SMS Consent - true or false
*Required
Response
- Profiles (array)
Unsubscribe and Remove Profile From List Using an Email Address
For more details and examples, go to the Klaviyo API Documentation - Unsubscribe Profiles From List
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
- Email* - Specify the User's email address that you would like to unsubscribe.
*Required
Response
- Empty Response - If the removal was successful, you should receive a success message 200.
Get Metrics Info
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get Metrics Info
Parameters
- No Parameters
Response
- Object
- Data (array)
- Page
- Start
- End
- Total
- Page Size
Get Events for All Metrics
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get Events for All Metrics
Parameters
- No Parameters
Response
- Object
- Data (array)
- Count
- Next
Get Events for a Specific Metric
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get Events for a Specific Metric
Parameters
- Metric ID* - The Metric ID is returned from the 'Get Metrics Info' API Call. For example: UMfZuG
*Required
Response
- Object
- Data (array)
- Count
- Next
Get Profile ID with an Email Address
For more details and examples, go to the Klaviyo API Documentation - Get Profile ID
Parameters
- Email* - Specify the email address of the Profile ID you would like to get.
*Required
Response
- Profile ID
Identify Profile with a Phone Number
For more details and examples, go to the Klaviyo API Documentation - Identify Profile
Parameters
- Phone Number* - Specify the phone number of the Profile you would like to identify.
*Required
Response
- Empty Response - If the identification was successful, you should receive a success message 200 and a raw response of 1.
Unsubscribe and Remove Profile From List Using a Phone Number
For more details and examples, go to the Klaviyo API Documentation - Unsubscribe Profiles From List
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
- Phone Number* - Specify the phone number of the Profile you would like to remove.
*Required
Response
- Empty Response - If the removal was successful, you should receive a success message 200.
Check if Profiles Are in a List Using an Email
For more details and examples, go to the Klaviyo API Documentation - Check if Profiles Are in a List
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
- Email* - Specify email address.
*Required
Response
- Profile ID
- Created Date/Time
- Profile Email
Check if Profiles Are in a List Using a Phone Number
For more details and examples, go to the Klaviyo API Documentation - Check if Profiles Are in a List
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
- Phone* - Specify phone number.
*Required
Response
- Profile ID
- Created Date/Time
- Profile Email
Check if Profiles Are in a List and Not Suppressed (Using an Email)
For more details and examples, go to the Klaviyo API Documentation - Check if Profiles Are in a List and not Suppressed
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
- Email* - Specify email address.
*Required
Response
- Profile ID
- Created At
- Profile Email
Check if Profiles Are in a List and Not Suppressed (Using a Phone Number)
For more details and examples, go to the Klaviyo API Documentation - Check if Profiles Are in a List and not Suppressed
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
- Phone* - Specify phone number.
*Required
Response
- Profile ID
- Created At
- Profile Email
Get Global Exclusions & Unsubscribes
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get Global Exclusions & Unsubscribes
Parameters
- No Parameters
Response
- Object
- Data (array)
Exclude Profile From All Email
For more details and examples, go to the Klaviyo API Documentation - Exclude Profile From All Email
Parameters
- Email* - Specify email address.
*Required
Response
- Already Excluded
- Number Excluded
Get All Exclusions for a List
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get All Exclusions for a List
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
*Required
Response
- Records (array)
Get List Members
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get List Members
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
*Required
Response
- Records (array)
Create New Template
For more details and examples, go to the Klaviyo API Documentation - Create New Template
Parameters
- Email Template Name*
- HTML String - The HTML body of the email. Example: <html><body><p>This is an email for {{ email }}.</p></body></html>
*Required
Response
- Object
- Template ID
- Template Name
- HTML
- Created
- Updated
Update Template
For more details and examples, go to the Klaviyo API Documentation - Update Template
Parameters
- Updated Email Template Name
- Updated HTML String - The HTML body of the email. Example: <html><body><p>This is an email for {{ email }}.</p></body></html>
- Template ID* - The Template ID is returned from the 'Create New Template' API Call. For example: RnkCEH
*Required
Response
- Object
- Template ID
- Template Name
- HTML
- Created
- Updated
Get All Templates
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get All Templates
Parameters
- No Parameters
Response
- Object
- Data (array)
Delete Template
For more details and examples, go to the Klaviyo API Documentation - Delete Template
Parameters
- Template ID* - The Template ID is returned from the 'Create New Template' API Call. For example: RnkCEH
*Required
Response
- Object
- Template ID
- Template Name
- Created
- Updated
Clone Template
Creates a copy of a given template with a new name.
For more details and examples, go to the Klaviyo API Documentation - Clone Template
Parameters
- Email Template Name - Specify the name for the cloned template.
- Template ID* - The Template ID is returned from the 'Create New Template' API Call. For example: RnkCEH
*Required
Response
- Object
- Template ID
- Template Name
- HTML
- Created
- Updated
Render Template
Both the Parameters and Request should be customized according to the corresponding Template ID.
For more details and examples, go to the Klaviyo API Documentation - Render Template
Parameters
- Template ID* - The Template ID is returned from the 'Create New Template' API Call. For example: RnkCEH
- Name - The person's name your email template will be rendered with.
- Email - The email address your email template will be rendered with.
*Required
Response
- Object
- Template ID
- Template Name
- HTML
- Created
- Updated
- Text
Create New Campaign
The created campaign is a draft and is not automatically sent.
For more details and examples, go to the Klaviyo API Documentation - Create New Campaign
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
- Template ID* - The Template ID is returned from the 'Create New Template' API Call. For example: RnkCEH
- Email of Sender*
- Name of Sender*
- Subject of Email*
- Campaign Name
- Use Smart Sending - If set, limits the number of emails sent to an individual within a short period. Valid values are true and false.
- Add Google Analytics - If specified, adds Google Analytics tracking tags to links. Valid values are true and false.
*Required
Response
- Object
- Campaign ID
- Subject
- From Email
- From Name
- Sent At
- Send Time
- Campaign Name
- Lists (array)
- Excluded Lists (array)
- Status
- Status ID
- Status Label
- Created
- Updated
- Number of Recipients
- Campaign Type
- Is Segmented
- Message Type
- Template Object
- Template ID
- Template HTML
Get Campaigns
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get Campaigns
Parameters
- No Parameters
Response
- Object
- Data (array)
Get a Specific Campaign's Info
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get a Specific Campaign's Info
Parameters
- Campaign ID* - The Campaign ID is returned from the 'Create New Campaign' API Call. For example: 01GCT1H5Z35HSD71EZ7HVBSRAC
*Required
Response
- Object
- Campaign ID
- Subject
- From Email
- From Name
- Sent At
- Send Time
- Campaign Name
- Lists (array)
- Excluded Lists (array)
- Status
- Status ID
- Status Label
- Created
- Updated
- Number of Recipients
- Campaign Type
- Is Segmented
- Message Type
- Template Object
- Template ID
- Template HTML
Update Campaign
You can update a campaign's name, subject, from email address, from name, template or list.
For more details and examples, go to the Klaviyo API Documentation - Update Campaign
Parameters
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
- Template ID* - The Template ID is returned from the 'Create New Template' API Call. For example: RnkCEH
- Email of Sender
- Name of Sender
- Subject of Email
- Campaign Name
- Use Smart Sending - If set, limits the number of emails sent to an individual within a short period. Valid values are true and false.
- Add Google Analytics - If specified, adds Google Analytics tracking tags to links. Valid values are true and false.
- Campaign ID* - The Campaign ID is returned from the 'Create New Campaign' API Call. For example: 01GCT1H5Z35HSD71EZ7HVBSRAC
*Required
Response
- Object
- Campaign ID
- Subject
- From Email
- From Name
- Sent At
- Send Time
- Campaign Name
- Lists (array)
- Excluded Lists (array)
- Status
- Status ID
- Status Label
- Created
- Updated
- Number of Recipients
- Campaign Type
- Is Segmented
- Message Type
- Template Object
- Template ID
- Template HTML
Send a Campaign Immediately
Queues a campaign for immediate delivery.
For more details and examples, go to the Klaviyo API Documentation - Send a Campaign Immediately
Parameters
- Campaign ID* - The Campaign ID is returned from the 'Create New Campaign' API Call. For example: 01GCT1H5Z35HSD71EZ7HVBSRAC
*Required
Response
- Status
Schedule a Campaign
For more details and examples, go to the Klaviyo API Documentation - Schedule a Campaign
Parameters
- Campaign ID* - The Campaign ID is returned from the 'Create New Campaign' API Call. For example: 01GCT1H5Z35HSD71EZ7HVBSRAC
- Send Time* - A timestamp of the format %Y-%m-%d %H:%M:%S (Year-Month-Day Hour:Minute:Second) in the UTC timezone. Ex: 2022-01-13 00:00:00
*Required
Response
- Status
Cancel a Campaign
Marks a campaign as cancelled regardless of it's current status.
For more details and examples, go to the Klaviyo API Documentation - Cancel a Campaign
Parameters
- Campaign ID* - The Campaign ID is returned from the 'Create New Campaign' API Call. For example: 01GCT1H5Z35HSD71EZ7HVBSRAC
*Required
Response
- Object
- Campaign ID
- Campaign Subject
- From Email
- From Name
- Sent At
- Send Time
- Campaign Name
- Lists (array)
- Excluded Lists (array)
- Campaign Status
- Status ID
- Status Label
- Created
- Updated
- Number of Recipients
- Campaign Type
- Is Segmented
- Message Type
- Template Object
- Template ID
- Template HTML
Clone a Campaign
Creates a copy of a given campaign with a new name. The new campaign starts as a draft.
For more details and examples, go to the Klaviyo API Documentation - Clone a Campaign
Parameters
- Campaign ID* - The Campaign ID is returned from the 'Create New Campaign' API Call. For example: 01GCT1H5Z35HSD71EZ7HVBSRAC
- List ID* - The List ID is returned from the 'Get Lists' API Call. For example: RChtDy
- Name* - Name for the new campaign.
*Required
Response
- Object
- Campaign ID
- Subject
- From Email
- From Name
- Sent At
- Send Time
- Campaign Name
- Lists (array)
- Excluded Lists (array)
- Status
- Status ID
- Status Label
- Created
- Updated
- Number of Recipients
- Campaign Type
- Is Segmented
- Message Type
- Template Object
- Template ID
- Template HTML
Get Campaign Recipients
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get Campaign Recipients
Parameters
- Campaign ID* - The Campaign ID is returned from the 'Create New Campaign' API Call. For example: 01GCT1H5Z35HSD71EZ7HVBSRAC
*Required
Response
- Count
- Data (array)
Get Segments
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get Segments
Parameters
- No Parameters
Response
- Data (array)
- Self Link
Get a Specific Segment
For more details and examples, go to the Klaviyo API Documentation - Get Segment
Parameters
- Segment ID* - The Segment ID is returned from the 'Get Segments' API Call. For example: RcqetJ
*Required
Response
- Data Type
- Data Segment ID
- Segment Name
- Segment Created At
- Segment Updated At
- Data Self Link
Update a Segment
For more details and examples, go to the Klaviyo API Documentation - Update Segment
Parameters
- Segment ID* - The Segment ID is returned from the 'Get Segments' API Call. For example: RcqetJ
- Updated Segment Name - Specify the updated name for the segment.
*Required
Response
- Data Type
- Data Segment ID
- Segment Name
- Segment Created At
- Segment Updated At
- Data Self Link
Get Segment Profiles
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get Segment Profiles
Parameters
- Segment ID* - The Segment ID is returned from the 'Get Segments' API Call. For example: RcqetJ
*Required
Response
- Data (array)
- Self Links
Get Segment Members
Note: This call returns an array, which can only be accessed in a Custom Component.
For more details and examples, go to the Klaviyo API Documentation - Get Segment Members
Parameters
- Segment ID* - The Segment ID is returned from the 'Get Segments' API Call. For example: RcqetJ
*Required
Response
- Records (array)
Check if Profiles Are in a Segment Using an Email
For more details and examples, go to the Klaviyo API Documentation - Check if Profiles Are in a Segment
Parameters
- Segment ID* - The Segment ID is returned from the 'Get Segments' API Call. For example: RcqetJ
- Email* - Specify email address.
*Required
Response
- Profile ID
- Created Date/Time
- Profile Email
Check if Profiles Are in a Segment Using a Phone Number
For more details and examples, go to the Klaviyo API Documentation - Check if Profiles Are in a Segment
Parameters
- Segment ID* - The Segment ID is returned from the 'Get Segments' API Call. For example: RcqetJ
- Phone* - Specify phone number.
*Required
Response
- Profile ID
- Created Date/Time
- Profile Email
More Details
To learn more about this Pipe and see additional Examples, please see the Klaviyo Developer Guide.
We'd love to hear your feedback.