Klaviyo

Create profiles, manage lists, and track events in Klaviyo.

MarketingAPI key11 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (11)
createProfile
addProfileToList
createList
custom_api_call
findListByName
findProfileByEmailPhone
findTagByName
removeProfileFromList
subscribeProfile
unsubscribeProfile
updateProfile
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("klaviyo", "createProfile", {});
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Klaviyo answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "klaviyo-createprofile",
  name: "Klaviyo: Create Profile",
  description: "Calls Klaviyo when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("klaviyo", {
      "action": "createProfile"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/klaviyo/createProfile" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{}}'

Actions

createProfilein catalog

Create Profile. Add new user profile with email/SMS subscription options

Input	Type	Description
`email`optional	text	Email address (recommended identifier)
`phone_number`optional	text	Phone number in E.164 format (e.g., +15005550006)
`external_id`optional	text	Unique identifier from external system
`first_name`optional	text	First Name
`last_name`optional	text	Last Name
`organization`optional	text	Company name
`locale`optional	text	Language tag (e.g., en-US)
`title`optional	text	Job Title
`image`optional	text	Profile image URL
`address1`optional	text	Street address line 1
`address2`optional	text	Street address line 2
`city`optional	text	City
`country`optional	text	Country
`region`optional	text	Region/State
`zip`optional	text	Zip Code
`timezone`optional	text	IANA timezone (e.g., America/New_York)
`ip`optional	text	IP Address
`latitude`optional	number	Latitude coordinate (4 decimal places recommended)
`longitude`optional	number	Longitude coordinate (4 decimal places recommended)
`custom_properties`optional	object	Key-value pairs for segmentation and personalization

addProfileToList

Add Profile to List. Add profiles to a specific list without changing subscription status.

Input	Type	Description
`list_id`required	id (picked from your account)	List Id
`profile_id`required	ids (picked from your account)	Select one or more Klaviyo profiles

createList

Create List. Create a new subscriber list.

Input	Type	Description
`name`required	text	Name for the new list

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

findListByName

Find List by Name. Find lists by name with optional additional data

Input	Type	Description
`search_query`required	long text	Enter list name
`include_additional_data`optional	boolean	Include related flow and tag information

findProfileByEmailPhone

Find Profile by Email/Phone. Find a profile using email or phone number.

Input	Type	Description
`search_query`required	text	Enter an email address or phone number (E.164 format recommended)
`include_additional_data`optional	boolean	Include subscriptions and predictive analytics data

findTagByName

Find Tag by Name. Find tags whose name contains the search query.

Input	Type	Description
`search_query`required	text	Search for tags whose name contains this value.

removeProfileFromList

Remove Profile from List. Remove profiles from a specific list.

Input	Type	Description
`list_id`required	id (picked from your account)	List Id
`profile_ids`required	ids (picked from your account)	Select one or more Klaviyo profiles

subscribeProfile

Subscribe Profile. Subscribe profiles to email or SMS marketing on a list.

Input	Type	Description
`list_id`required	id (picked from your account)	List Id
`profile_ids`required	ids (picked from your account)	Select one or more Klaviyo profiles
`subscribe_email`optional	boolean	Subscribe selected profiles to email marketing.
`subscribe_sms`optional	boolean	Subscribe selected profiles to SMS marketing.
`historical_import`optional	boolean	Bypass double opt-in and mark as a historical import.
`consented_at`optional	text	ISO 8601 datetime when consent was given (required for historical import, e.g. 2024-01-15T10:00:00Z).
`custom_source`optional	text	Label for the subscription source (e.g. "Website Form").

unsubscribeProfile

Unsubscribe Profile. Unsubscribe profiles from email or SMS marketing on a list.

Input	Type	Description
`list_id`required	id (picked from your account)	List Id
`profile_ids`required	ids (picked from your account)	Select one or more Klaviyo profiles
`unsubscribe_email`optional	boolean	Unsubscribe selected profiles from email marketing.
`unsubscribe_sms`optional	boolean	Unsubscribe selected profiles from SMS marketing.
`unsubscribe_sms_transactional`optional	boolean	Unsubscribe selected profiles from SMS transactional messages.

updateProfile

Update Profile. Update existing profile data and preferences.

Input	Type	Description
`profile_id`required	id (picked from your account)	Profile Id
`email`optional	text	Individual's email address
`phone_number`optional	text	Phone number in E.164 format (e.g., +15005550006)
`external_id`optional	text	Unique identifier from external system (e.g., POS system)
`anonymous_id`optional	text	Anonymous identifier for the profile
`first_name`optional	text	Individual's first name
`last_name`optional	text	Individual's last name
`organization`optional	text	Company or organization name
`locale`optional	text	Locale in IETF BCP 47 format (e.g., en-US)
`title`optional	text	Individual's job title
`image`optional	text	URL pointing to profile image location
`address1`optional	text	First line of street address
`address2`optional	text	Second line of street address
`city`optional	text	City name
`country`optional	text	Enter 2-letter ISO country code. Popular: US, GB, CA, DE, FR, AU, JP, CN, IN, BR
`region`optional	text	Region within country (state/province)
`zip`optional	text	Postal/zip code
`timezone`optional	text	IANA timezone (e.g., America/New_York)
`ip`optional	text	IP address of the profile
`latitude`optional	number	Latitude coordinate (4 decimal places recommended)

Details

Id: klaviyo
Category: Marketing
Tags: email, ecommerce, sms, marketing-automation
Package: @activepieces/piece-klaviyo@0.0.1
Tier: Community