> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Klaviyo

> How to set up the Klaviyo connector, plus the actions and events that are available.

![Klaviyo](https://stackone-logos.com/api/klaviyo/filled/svg)

v2.0.0[See changelog](https://docs.stackone.com/connectors/klaviyo/changelog.md)

[172 actions](#actions) · [25 events](#events) · 2 auth methods

Marketing
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Private API Key · Connector Profile](https://docs.stackone.com/connectors/klaviyo/guides/connector-profile/private-api-key.md)
>
> Best for server-side integrations within a single Klaviyo account. Never expose in client-side code.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/klaviyo/guides/connector-profile/oauth-2-0.md)
>
> Recommended for partner integrations and multi-account apps. Each user authorizes access to their own Klaviyo data.

Optionally, configure receiving Events for Klaviyo into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/klaviyo/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Private API Key · Link Account](https://docs.stackone.com/connectors/klaviyo/guides/link-account/private-api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/klaviyo/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

accounts:read

campaigns:read

campaigns:write

catalogs:read

catalogs:write

coupon-codes:read

coupon-codes:write

coupons:read

coupons:write

data-privacy:write

events:read

events:write

flows:read

flows:write

forms:read

forms:write

images:read

images:write

lists:read

lists:write

metrics:read

metrics:write

profiles:read

profiles:write

segments:read

segments:write

tags:read

tags:write

templates:read

templates:write

webhooks:read

webhooks:write

No scopes found

172 actions

ActionDescriptionRequired scopes

Get Accounts`klaviyo_get_accounts`

Retrieve all Klaviyo accounts associated with the current API key. Always returns exactly one account object per key.

`accounts:read`

Get Account`klaviyo_get_account`

Retrieve detailed configuration for a specific Klaviyo account by its unique account ID.

`accounts:read`

List Campaigns`klaviyo_list_campaigns`

List email, SMS, or push campaigns with required channel filter and optional sorting and pagination.

`campaigns:read`

Get Campaign`klaviyo_get_campaign`

Retrieve complete details for a single campaign by its unique ID, including status, audiences, send strategy, and tracki...

`campaigns:read`

Create Campaign`klaviyo_create_campaign`

Create a new email, SMS, or mobile push campaign as a draft. Requires specifying the channel, audiences, and at least on...

`campaigns:write`

Update Campaign`klaviyo_update_campaign`

Update campaign properties such as name, target audiences, send strategy, or tracking options before the campaign is sen...

`campaigns:write`

Delete Campaign`klaviyo_delete_campaign`

Permanently delete a campaign by ID. This action cannot be undone. Only Draft campaigns can be deleted.

`campaigns:write`

Clone Campaign`klaviyo_clone_campaign`

Duplicate an existing campaign to create a new Draft campaign, optionally giving it a new name.

`campaigns:write`

Get Campaign Recipient Estimation`klaviyo_get_campaign_recipient_estimation`

Get the current estimated number of recipients for a campaign based on its configured audiences.

`campaigns:read`

Refresh Campaign Recipient Estimation`klaviyo_refresh_campaign_recipient_estimation`

Trigger an asynchronous job that (re)computes the estimated recipient count for a campaign, so get\_campaign\_recipient\_es...

`campaigns:write`

Get Campaign Recipient Estimation Job`klaviyo_get_campaign_recipient_estimation_job`

Check the status of an estimation job previously triggered by refresh\_campaign\_recipient\_estimation.

`campaigns:read`

Get Tags For Campaign`klaviyo_get_tags_for_campaign`

Retrieve all tags associated with a specific campaign for organizational and filtering purposes.

`campaigns:read`

Get Messages For Campaign`klaviyo_get_messages_for_campaign`

Retrieve all campaign messages (email, SMS, or push variants) that belong to a specific campaign.

`campaigns:read`

Get Campaign Message`klaviyo_get_campaign_message`

Retrieve full details for a specific campaign message by its unique ID, including channel-specific content and render op...

`campaigns:read`

Update Campaign Message`klaviyo_update_campaign_message`

Update the content and settings of a campaign message, including channel-specific fields such as subject, body, sender i...

`campaigns:write`

Assign Template To Campaign Message`klaviyo_assign_template_to_campaign_message`

Assign an email template to a campaign message, creating a non-reusable snapshot of the template's HTML for that message...

`campaigns:write`

Send Campaign`klaviyo_send_campaign`

Trigger a campaign to send immediately (or at its configured scheduled time) by creating an asynchronous send job. Campa...

`campaigns:write`

Cancel Campaign Send`klaviyo_cancel_campaign_send`

Cancel an in-progress campaign send job or revert a scheduled campaign back to Draft status. Campaign must be in Schedul...

`campaigns:write`

List Catalog Items`klaviyo_list_catalog_items`

List all product catalog items in the account with filtering by title, category, or IDs, sorting by creation date, and c...

`catalogs:read`

Create Catalog Item`klaviyo_create_catalog_item`

Create a new product catalog item with title, description, URL, price, and images, optionally assigning it to one or mor...

`catalogs:write`

Get Catalog Item`klaviyo_get_catalog_item`

Retrieve the full details of a specific catalog item by its compound ID, with optional variant inclusion and sparse fiel...

`catalogs:read`

Update Catalog Item`klaviyo_update_catalog_item`

Update an existing catalog item's title, description, URL, price, images, or published status using PATCH semantics - on...

`catalogs:write`

Delete Catalog Item`klaviyo_delete_catalog_item`

Permanently delete a catalog item by its compound ID, removing it from all recommendation feeds and product blocks.

`catalogs:write`

Bulk Create Catalog Items`klaviyo_bulk_create_catalog_items`

Submit an asynchronous bulk job to create up to 100 catalog items in a single request, returning a job ID to poll for co...

`catalogs:read`

Bulk Update Catalog Items`klaviyo_bulk_update_catalog_items`

Submit an asynchronous bulk job to update up to 100 existing catalog items in a single request, returning a job ID to po...

`catalogs:read`

Bulk Delete Catalog Items`klaviyo_bulk_delete_catalog_items`

Submit an asynchronous bulk job to permanently delete up to 100 catalog items in a single request, returning a job ID to...

`catalogs:read`

List Catalog Categories`klaviyo_list_catalog_categories`

List all product catalog categories in the account with filtering by name or item membership, sorting by creation date,...

`catalogs:read`

Create Catalog Category`klaviyo_create_catalog_category`

Create a new product catalog category with an external ID and display name, optionally assigning catalog items to it at...

`catalogs:write`

Get Catalog Category`klaviyo_get_catalog_category`

Retrieve the full details of a specific catalog category by its compound ID, including its name and external ID.

`catalogs:read`

Update Catalog Category`klaviyo_update_catalog_category`

Update an existing catalog category's name or item associations using PATCH semantics - only supplied fields are changed...

`catalogs:write`

Delete Catalog Category`klaviyo_delete_catalog_category`

Permanently delete a catalog category by its compound ID, removing the category grouping without deleting the items it c...

`catalogs:write`

Bulk Create Catalog Categories`klaviyo_bulk_create_catalog_categories`

Submit an asynchronous bulk job to create up to 100 catalog categories in a single request, returning a job ID to poll f...

`catalogs:read`

Bulk Update Catalog Categories`klaviyo_bulk_update_catalog_categories`

Submit an asynchronous bulk job to update up to 100 existing catalog categories in a single request, returning a job ID...

`catalogs:read`

Bulk Delete Catalog Categories`klaviyo_bulk_delete_catalog_categories`

Submit an asynchronous bulk job to permanently delete up to 100 catalog categories in a single request, returning a job...

`catalogs:read`

List Catalog Variants`klaviyo_list_catalog_variants`

List all product catalog variants in the account with filtering by item, SKU, title, or published status, sorting by cre...

`catalogs:read`

Create Catalog Variant`klaviyo_create_catalog_variant`

Create a new catalog variant (size, color, or style variation) for an existing catalog item, with SKU, inventory, price,...

`catalogs:write`

Get Catalog Variant`klaviyo_get_catalog_variant`

Retrieve the full details of a specific catalog variant by its compound ID, including SKU, inventory quantity, price, an...

`catalogs:read`

Update Catalog Variant`klaviyo_update_catalog_variant`

Update an existing catalog variant's SKU, price, inventory quantity, title, images, or published status using PATCH sema...

`catalogs:write`

Delete Catalog Variant`klaviyo_delete_catalog_variant`

Permanently delete a catalog variant by its compound ID, removing it from recommendation feeds and back-in-stock subscri...

`catalogs:write`

Bulk Create Catalog Variants`klaviyo_bulk_create_catalog_variants`

Submit an asynchronous bulk job to create up to 100 catalog variants in a single request, each linked to an existing par...

`catalogs:read`

Bulk Update Catalog Variants`klaviyo_bulk_update_catalog_variants`

Submit an asynchronous bulk job to update up to 100 existing catalog variants in a single request, returning a job ID to...

`catalogs:read`

Bulk Delete Catalog Variants`klaviyo_bulk_delete_catalog_variants`

Submit an asynchronous bulk job to permanently delete up to 100 catalog variants in a single request, returning a job ID...

`catalogs:read`

Get Items For Catalog Category`klaviyo_get_items_for_catalog_category`

List all catalog items that belong to a specific catalog category, with sparse fieldsets, optional variant inclusion, fi...

`catalogs:read`

Add Items To Catalog Category`klaviyo_add_items_to_catalog_category`

Additively associate one or more catalog items with a specific category without replacing existing item memberships.

`catalogs:read`

Remove Items From Catalog Category`klaviyo_remove_items_from_catalog_category`

Remove specific catalog items from a category's membership without affecting other items already in the category.

`catalogs:write`

Add Categories To Catalog Item`klaviyo_add_categories_to_catalog_item`

Additively assign one or more catalog categories to a specific item without replacing its existing category memberships.

`catalogs:read`

Remove Categories From Catalog Item`klaviyo_remove_categories_from_catalog_item`

Remove specific category assignments from a catalog item without affecting the item's other category memberships.

`catalogs:write`

Create Back In Stock Subscription`klaviyo_create_back_in_stock_subscription`

Subscribe an existing profile to back-in-stock notifications for a specific catalog variant via EMAIL, PUSH, or SMS chan...

`catalogs:read`

Create Client Event`klaviyo_create_client_event`

Track a client-side event from a browser or mobile app using the public API key. No server-side credentials required.

`events:write`

Create Client Profile`klaviyo_create_client_profile`

Create or update a Klaviyo profile from client-side code using the public API key. Safe for use in browser and mobile ap...

`profiles:write`

List Coupons`klaviyo_list_coupons`

List all coupons in the account with optional sparse fieldsets and cursor-based pagination.

`coupons:read`

Create Coupon`klaviyo_create_coupon`

Create a new coupon container with a unique external ID, matching your e-commerce platform's coupon identifier.

`coupons:write`

Get Coupon`klaviyo_get_coupon`

Retrieve complete details for a specific coupon by its unique Klaviyo coupon ID.

`coupons:read`

Update Coupon`klaviyo_update_coupon`

Update the description or monitor configuration of an existing coupon. The external\_id cannot be changed after creation....

`coupons:write`

Delete Coupon`klaviyo_delete_coupon`

Permanently delete a coupon and all its associated coupon codes. This action is irreversible. Note: Shopify-originated c...

`coupons:write`

List Coupon Codes`klaviyo_list_coupon_codes`

List coupon codes filtered by coupon ID or profile ID. A filter specifying coupon.id or profile.id is required.

`coupon-codes:read`

Create Coupon Code`klaviyo_create_coupon_code`

Create a single unique coupon code and associate it with an existing coupon. Use bulk\_create\_coupon\_codes for creating m...

`coupon-codes:write`

Get Coupon Code`klaviyo_get_coupon_code`

Retrieve full details for a specific coupon code by its unique ID, including its status, unique code value, and expirati...

`coupon-codes:read`

Update Coupon Code`klaviyo_update_coupon_code`

Update the status or expiration date of an existing coupon code. Useful for manually marking codes as used or extending...

`coupon-codes:write`

Delete Coupon Code`klaviyo_delete_coupon_code`

Permanently delete a single coupon code by its ID. This action is irreversible.

`coupon-codes:write`

Bulk Create Coupon Codes`klaviyo_bulk_create_coupon_codes`

Create up to 1000 coupon codes in a single bulk job, associating each with an existing coupon.

`coupon-codes:write`

List Events`klaviyo_list_events`

List Klaviyo events (customer activity records) with optional filtering by metric, profile, or date range.

`events:read`

Create Event`klaviyo_create_event`

Track a server-side customer activity event for a profile, such as a purchase, page view, or custom business action.

`events:write`

Get Event`klaviyo_get_event`

Retrieve complete details for a specific event by its unique ID, including all event properties and optional metric and...

`events:read`

Bulk Create Events`klaviyo_bulk_create_events`

Efficiently ingest up to 1000 events in a single asynchronous bulk job, grouped by profile for high-volume tracking scen...

`events:write`

List Flows`klaviyo_list_flows`

List all Klaviyo automation flows with optional filtering by name, status, trigger type, and date, plus pagination and s...

`flows:read`

Get Flow`klaviyo_get_flow`

Retrieve the full configuration of a specific Klaviyo flow by its unique ID, including trigger definition and optional f...

`flows:read`

Get Flow Action`klaviyo_get_flow_action`

Retrieve detailed configuration for a single flow action step by its unique ID, including its type, branching links, and...

`flows:read`

Get Flow Message`klaviyo_get_flow_message`

Retrieve the content and configuration of a specific flow message by its ID, including channel-specific content and temp...

`flows:read`

List Flow Actions For Flow`klaviyo_get_actions_for_flow`

List all action steps for a specific flow with pagination, filtering by action type or status, and sorting.

`flows:read`

Get Tags For Flow`klaviyo_get_tags_for_flow`

Retrieve all tags associated with a specific flow for organizational and categorization purposes.

`flows:read`

Get Flow Action Messages`klaviyo_get_flow_action_messages`

List all message variants associated with a specific flow action step, with pagination, filtering, and sorting options.

`flows:read`

Create Flow`klaviyo_create_flow`

Create a new Klaviyo automation flow with a trigger, chained actions, and optional profile filters. Use this to programm...

`flows:write`

Delete Flow`klaviyo_delete_flow`

Permanently delete a flow and all its actions by flow ID. Use this to remove test flows or decommission automation workf...

`flows:write`

Update Flow Action`klaviyo_update_flow_action`

Update a single action within a flow — change email subject lines, SMS body text, delay durations, split conditions, or...

`flows:write`

List Forms`klaviyo_list_forms`

List all signup forms and pop-ups in the account with filtering, sorting, and cursor-based pagination up to 100 results...

`forms:read`

Get Form`klaviyo_get_form`

Retrieve the full configuration and version history for a specific Klaviyo form by its unique ID.

`forms:read`

Create Form`klaviyo_create_form`

Create a new Klaviyo form — popup, flyout, embed, banner, or full screen. Use this to programmatically deploy signup for...

`forms:write`

Delete Form`klaviyo_delete_form`

Permanently delete a form by its ID. Use this to remove test forms or decommission form experiences. This action cannot...

`forms:write`

Get Unified Credentials`klaviyo_unified_get_me`

Return connection identity for the current Klaviyo connection. name is derived from the account organization name (via /...

List Unified Organizations`klaviyo_unified_list_organizations`

Return the Klaviyo account as an IAM organization. Klaviyo is single-tenant per credential — /api/accounts always return...

`accounts:read`

Get Unified Organization`klaviyo_unified_get_organization`

Retrieve a single Klaviyo account by id, mapped to the IAM unified organization schema. Klaviyo is single-tenant per cre...

`accounts:read`

List Unified Roles`klaviyo_unified_list_roles`

Return the seven built-in Klaviyo IAM roles (Owner, Admin, Manager, Analyst, Campaign Coordinator, Content Creator, Supp...

Get Unified Role`klaviyo_unified_get_role`

Retrieve a single synthesized Klaviyo IAM role by id (one of owner, admin, manager, analyst, campaign\_coordinator, conte...

List Unified Users`klaviyo_unified_list_users`

List all users (team members) in the Klaviyo account via the SCIM v2 bridge, mapped to the StackOne IAM unified user sch...

Get Unified User`klaviyo_unified_get_user`

Retrieve a single Klaviyo team member by their SCIM ID, mapped to the StackOne IAM unified user schema. Returns identity...

List Images`klaviyo_list_images`

List all images in the Klaviyo asset library with filtering by name, format, size, or visibility, plus sorting and pagin...

`images:read`

Upload Image From URL`klaviyo_upload_image_from_url`

Import an image into the Klaviyo asset library from a public URL or a base64-encoded data URI.

`images:write`

Get Image`klaviyo_get_image`

Retrieve complete metadata for a specific image in the Klaviyo asset library by its unique ID.

`images:read`

Update Image`klaviyo_update_image`

Update the name or visibility (hidden status) of an existing image in the Klaviyo asset library.

`images:write`

List Lists`klaviyo_list_lists`

List all subscriber lists in the account with filtering by name or timestamps, sorting, and cursor-based pagination up t...

`lists:read`

Create List`klaviyo_create_list`

Create a new subscriber list with a specified name and opt-in process (single or double opt-in) for managing profile sub...

`lists:write`

Get List`klaviyo_get_list`

Retrieve the full details of a specific subscriber list by its unique ID, with optional profile count, tags, and flow tr...

`lists:read`

Update List`klaviyo_update_list`

Update the name or opt-in process (single vs double opt-in) of an existing subscriber list using PATCH semantics.

`lists:write`

Delete List`klaviyo_delete_list`

Permanently delete a subscriber list from the account - this removes the list definition but does not delete the profile...

`lists:write`

Get Tags For List`klaviyo_get_tags_for_list`

Retrieve all tags that have been applied to a specific subscriber list, returning full tag objects including their names...

`lists:read``tags:read`

Get Profiles For List`klaviyo_get_profiles_for_list`

Retrieve all profile members of a subscriber list with filtering, sorting by join date, and cursor-based pagination up t...

`lists:read``profiles:read`

Add Profiles To List`klaviyo_add_profiles_to_list`

Add one or more existing profiles to a subscriber list by their profile IDs, up to 1000 profiles per call.

`profiles:write``lists:write`

Remove Profiles From List`klaviyo_remove_profiles_from_list`

Remove one or more profiles from a subscriber list by their profile IDs, up to 1000 per call, without affecting their su...

`lists:write``profiles:write`

Get Flows Triggered By List`klaviyo_get_flows_triggered_by_list`

Retrieve all automation flows that use a specific subscriber list as their trigger, useful for understanding dependencie...

`flows:read``lists:read`

List Metrics`klaviyo_list_metrics`

List all event metric types tracked in the Klaviyo account, including built-in and integration-specific metrics, up to 2...

`metrics:read`

Get Metric`klaviyo_get_metric`

Retrieve complete details for a specific event metric type by its unique ID, including integration source and optional f...

`metrics:read`

Query Metric Aggregates`klaviyo_query_metric_aggregate`

Query aggregated event data for a metric over a date range, with grouping by time intervals, campaign, flow, channel, or...

`metrics:read`

Get Metric Property`klaviyo_get_metric_property`

Retrieve the definition and inferred data type of a specific metric property, with optional sample values for reference.

`metrics:read`

Get Flows Triggered By Metric`klaviyo_get_flows_triggered_by_metric`

Retrieve all automation flows that use a specific metric as their entry trigger event.

`metrics:read`

List Custom Metrics`klaviyo_list_custom_metrics`

List all custom composite metrics in the account that combine multiple underlying metrics into a single unified reportin...

`metrics:read`

Create Custom Metric`klaviyo_create_custom_metric`

Create a new custom composite metric that aggregates multiple base metrics into a single unified metric for attribution...

`metrics:write`

Get Custom Metric`klaviyo_get_custom_metric`

Retrieve the full definition and composition details for a specific custom composite metric by its unique ID.

`metrics:read`

Update Custom Metric`klaviyo_update_custom_metric`

Update the name or definition of an existing custom composite metric using PATCH semantics.

`metrics:write`

Delete Custom Metric`klaviyo_delete_custom_metric`

Permanently delete a custom composite metric from the account by its unique ID.

`metrics:write`

List Profiles`klaviyo_list_profiles`

List all customer profiles in the account with rich filtering, sorting, subscription and predictive analytics data, up t...

`profiles:read`

Get Profile`klaviyo_get_profile`

Retrieve the complete data for a specific customer profile by its Klaviyo ID, including optional subscription consent, l...

`profiles:read`

Create Profile`klaviyo_create_profile`

Create a new customer profile with contact details, location, and custom properties; at least one of email, phone\_number...

`profiles:write`

Update Profile`klaviyo_update_profile`

Update an existing customer profile's contact details, location, or custom properties using PATCH semantics, with suppor...

`profiles:write`

Get Lists For Profile`klaviyo_get_lists_for_profile`

Retrieve all subscriber lists that a specific profile is a member of, returning full list objects with name, opt-in proc...

`profiles:read`

Get Segments For Profile`klaviyo_get_segments_for_profile`

Retrieve all dynamic and static segments that a specific profile currently qualifies for, returning full segment objects...

`lists:read``profiles:read`

Merge Profiles`klaviyo_merge_profiles`

Permanently merge one or more source profiles into a destination profile, consolidating their event history, list member...

`profiles:read`

Bulk Import Profiles`klaviyo_bulk_import_profiles`

Submit an asynchronous bulk import job to create or update up to 10,000 profiles in a single request, with optional list...

`profiles:write`

Get List For Bulk Import Profiles Job`klaviyo_get_list_for_bulk_import_profiles_job`

Retrieve the subscriber list(s) that profiles were added to during a specific bulk profile import job, useful for verify...

`lists:read`

Get Profiles For Bulk Import Profiles Job`klaviyo_get_profiles_for_bulk_import_profiles_job`

Retrieve all profiles that were successfully created or updated by a completed bulk profile import job, with pagination...

`lists:read`

Request Profile Deletion`klaviyo_request_profile_deletion`

Submit a GDPR/CCPA-compliant data deletion request for a profile identified by email, phone number, or Klaviyo profile I...

`data-privacy:write`

Query Campaign Values`klaviyo_query_campaign_values`

Generate a campaign performance report with aggregate statistics (opens, clicks, revenue, conversions) for a given timef...

`campaigns:read``flows:read``forms:read``segments:read`

Query Flow Values`klaviyo_query_flow_values`

Generate a flow performance report with aggregate statistics (opens, clicks, revenue, conversions) broken down by flow,...

`flows:read`

Query Flow Series`klaviyo_query_flow_series`

Generate a time-series flow performance report with statistics aggregated into daily, weekly, monthly, or hourly interva...

`flows:read`

Query Segment Values`klaviyo_query_segment_values`

Generate a segment membership report showing how many profiles were added, removed, or are currently in a segment over a...

`segments:read`

Query Segment Series`klaviyo_query_segment_series`

Generate a time-series segment membership report with statistics aggregated into daily, weekly, monthly, or hourly inter...

`segments:read`

List Segments`klaviyo_list_segments`

List all segments in the account with filtering by name, status, or timestamps, sorting, and cursor-based pagination, in...

`segments:read`

Create Segment`klaviyo_create_segment`

Create a new segment with complex condition groups

`segments:write`

Get Segment`klaviyo_get_segment`

Retrieve the full details of a specific segment by its unique ID, including its condition definition, active status, and...

`segments:read`

Update Segment`klaviyo_update_segment`

Update an existing segment with new properties or definition

`segments:write`

Delete Segment`klaviyo_delete_segment`

Permanently delete a segment from the account by its unique ID - this removes the segment definition but does not delete...

`segments:write`

Get Tags For Segment`klaviyo_get_tags_for_segment`

Retrieve all tags applied to a specific segment, returning full tag objects with their names for auditing and UI display...

`segments:read`

Get Profiles For Segment`klaviyo_get_profiles_for_segment`

Retrieve all profiles currently matching a segment's conditions, with filtering by contact details or join date, sorting...

`segments:read`

Get Flows Triggered By Segment`klaviyo_get_flows_triggered_by_segment`

Retrieve all automation flows that use a specific segment as their trigger, useful for understanding dependencies before...

`segments:read`

List Tags`klaviyo_list_tags`

List all tags in the account with cursor-based pagination, name filtering, and optional tag group inclusion, up to 50 re...

`tags:read`

Create Tag`klaviyo_create_tag`

Create a new tag, optionally associating it with a specific tag group, or it defaults to the account's default tag group...

`tags:write`

Get Tag`klaviyo_get_tag`

Retrieve complete details for a specific tag by its unique ID, including optional tag group relationship.

`tags:read`

Update Tag`klaviyo_update_tag`

Update the name of an existing tag by its unique ID using PATCH semantics.

`tags:write`

Delete Tag`klaviyo_delete_tag`

Permanently delete a tag and automatically remove all its associations with campaigns, flows, lists, and segments.

`tags:write`

Get Flow IDs For Tag`klaviyo_get_flow_ids_for_tag`

Retrieve the IDs of all automation flows that are associated with a specific tag.

`flows:read``tags:read`

Tag Flows`klaviyo_tag_flows`

Apply a tag to one or more automation flows to organize and categorize them in the Klaviyo UI.

`flows:write``tags:write`

Get Campaign IDs For Tag`klaviyo_get_campaign_ids_for_tag`

Retrieve the IDs of all campaigns that are associated with a specific tag.

`campaigns:read``tags:read`

Tag Campaigns`klaviyo_tag_campaigns`

Apply a tag to one or more campaigns to organize and categorize them in the Klaviyo UI.

`campaigns:write``tags:write`

Get List IDs For Tag`klaviyo_get_list_ids_for_tag`

Retrieve the IDs of all subscriber lists that are associated with a specific tag.

`lists:read``tags:read`

Tag Lists`klaviyo_tag_lists`

Apply a tag to one or more subscriber lists to organize and categorize them in the Klaviyo UI.

`lists:write``tags:write`

Get Segment IDs For Tag`klaviyo_get_segment_ids_for_tag`

Retrieve the IDs of all segments that are associated with a specific tag.

`segments:read``tags:read`

Tag Segments`klaviyo_tag_segments`

Apply a tag to one or more audience segments to organize and categorize them in the Klaviyo UI.

`segments:write``tags:write`

List Tag Groups`klaviyo_list_tag_groups`

List all tag groups in the account with filtering by name, exclusivity, or default status, and cursor-based pagination u...

`tags:read`

Create Tag Group`klaviyo_create_tag_group`

Create a new tag group to organize related tags under a shared category, with optional exclusivity enforcement across th...

`tags:write`

Get Tag Group`klaviyo_get_tag_group`

Retrieve the full details of a specific tag group by its unique ID, including its name, exclusivity setting, and default...

`tags:read`

Update Tag Group`klaviyo_update_tag_group`

Update the name of an existing tag group using PATCH semantics - only the name can be changed, not the exclusivity or de...

`tags:write`

Delete Tag Group`klaviyo_delete_tag_group`

Permanently delete a tag group and all of its tags and their resource associations - the account's default tag group can...

`tags:write`

Get Tags For Tag Group`klaviyo_get_tags_for_tag_group`

Retrieve all tags that belong to a specific tag group, returning the full tag objects including their names.

`tags:read`

List Templates`klaviyo_list_templates`

List all email templates in the account with filtering by name or timestamps, sorting, and cursor-based pagination up to...

`templates:read`

Create Template`klaviyo_create_template`

Create a new email template with custom HTML content or a drag-and-drop structure, for use in campaigns and automated fl...

`templates:write`

Get Template`klaviyo_get_template`

Retrieve the full HTML content and metadata for a specific email template by its unique ID.

`templates:read`

Update Template`klaviyo_update_template`

Update the HTML content, plaintext version, AMP version, or name of an existing email template using PATCH semantics - n...

`templates:write`

Delete Template`klaviyo_delete_template`

Permanently delete an email template from the account by its unique ID - this action cannot be undone.

`templates:write`

Render Template`klaviyo_render_template`

Render an email template with sample profile context data to preview the final HTML, plaintext, and AMP output before se...

`templates:read`

Clone Template`klaviyo_clone_template`

Create a duplicate copy of an existing email template with an optional new name, useful for creating variations without...

`templates:write`

List Universal Content`klaviyo_list_universal_content`

List all reusable universal content blocks in the account with filtering by name, content type, or timestamps, sorting,...

`templates:read`

Create Universal Content`klaviyo_create_universal_content`

Create a new reusable universal content block (button, image, text, HTML, spacer, horizontal rule, or drop shadow) that...

`templates:write`

Get Universal Content`klaviyo_get_universal_content`

Retrieve the full definition and metadata of a specific universal content block by its unique ID, including block type,...

`templates:read`

Update Universal Content`klaviyo_update_universal_content`

Update the name or block definition of an existing universal content block using PATCH semantics - changes propagate to...

`templates:write`

Delete Universal Content`klaviyo_delete_universal_content`

Permanently delete a universal content block from the account - any templates that embed this block will lose the refere...

`templates:write`

List Webhooks`klaviyo_list_webhooks`

List all webhook subscriptions configured in the account, with optional inclusion of their subscribed topic definitions.

`webhooks:read`

Get Webhook`klaviyo_get_webhook`

Retrieve the full configuration details of a specific webhook subscription by its unique ID, including endpoint URL, ena...

`webhooks:read`

Create Webhook`klaviyo_create_webhook`

Create a new webhook subscription with an HTTPS endpoint URL, signing secret, and one or more event topic subscriptions...

`webhooks:write`

Update Webhook`klaviyo_update_webhook`

Update a webhook's name, endpoint URL, signing secret, enabled status, or topic subscriptions using PATCH semantics - us...

`webhooks:write`

Delete Webhook`klaviyo_delete_webhook`

Permanently delete a webhook subscription from the account, stopping all event notifications to that endpoint.

`webhooks:write`

List Webhook Topics`klaviyo_list_webhook_topics`

Retrieve all available webhook event topics that can be subscribed to, returning topic IDs and descriptions for use when...

`webhooks:read`

Get Webhook Topic`klaviyo_get_webhook_topic`

Retrieve the full details of a specific webhook topic by its ID, including the event schema, payload structure, and desc...

`webhooks:read`

## Events

Tags

Select all
|
Clear

Emails

Push Notifications

Reviews

SMS Messages

No tags found

25 events

EventDescriptionTags

Email Delivered`klaviyo_webhook_received_email`

Fires when an email is delivered to a recipient.

Emails

Opened Email`klaviyo_webhook_opened_email`

Fires when a recipient opens an email.

Emails

Clicked Email`klaviyo_webhook_clicked_email`

Fires when a recipient clicks a link in an email.

Emails

Bounced Email`klaviyo_webhook_bounced_email`

Fires when an email soft or hard bounced.

Emails

Dropped Email`klaviyo_webhook_dropped_email`

Fires when a discrepancy occurs between the Klaviyo suppression status and the upstream email service provider, and the...

Emails

Marked Email as Spam`klaviyo_webhook_marked_email_as_spam`

Fires when a recipient marks an email as spam.

Emails

Subscribed to Email Marketing`klaviyo_webhook_subscribed_to_email_marketing`

Fires when a profile consents to email marketing.

Emails

Unsubscribed from Email Marketing`klaviyo_webhook_unsubscribed_from_email_marketing`

Fires when a profile unsubscribes from email marketing.

Emails

Manually Suppressed from Email Marketing`klaviyo_webhook_manually_suppressed_from_email_marketing`

Fires when a profile is manually suppressed from email marketing.

Emails

Manually Unsuppressed from Email Marketing`klaviyo_webhook_manually_unsuppressed_from_email_marketing`

Fires when a profile is manually unsuppressed from email marketing.

Emails

Updated Email Preferences`klaviyo_webhook_updated_email_preferences`

Fires when a profile updates its preferences through the Manage Preferences link.

Emails

Sent SMS`klaviyo_webhook_sent_sms`

Fires when a recipient sends an inbound SMS to one of your Klaviyo sending numbers.

SMS Messages

Received SMS`klaviyo_webhook_received_sms`

Fires when Klaviyo records that a recipient received an SMS message.

SMS Messages

Clicked SMS`klaviyo_webhook_clicked_sms`

Fires when a recipient clicks a link within an SMS message.

SMS Messages

Failed to Deliver SMS`klaviyo_webhook_failed_to_deliver_sms`

Fires when an SMS message is sent but not delivered to the recipient.

SMS Messages

Received Automated Response SMS`klaviyo_webhook_received_automated_response_sms`

Fires when a recipient receives an automated SMS response to a keyword or auto-responder.

SMS Messages

Failed to Deliver Automated Response SMS`klaviyo_webhook_failed_to_deliver_automated_response_sms`

Fires when an automated SMS response fails to be delivered to the recipient.

SMS Messages

Subscribed to SMS Marketing`klaviyo_webhook_subscribed_to_sms_marketing`

Fires when a profile consents to SMS marketing.

SMS Messages

Unsubscribed from SMS Marketing`klaviyo_webhook_unsubscribed_from_sms_marketing`

Fires when a profile unsubscribes from SMS marketing.

SMS Messages

Received Push`klaviyo_webhook_received_push`

Fires when a recipient receives a push notification from a flow or campaign.

Push Notifications

Opened Push`klaviyo_webhook_opened_push`

Fires when a recipient taps a push notification and opens the app.

Push Notifications

Bounced Push`klaviyo_webhook_bounced_push`

Fires when a push notification is sent but not delivered.

Push Notifications

Ready to Review`klaviyo_webhook_ready_to_review`

Fires when a product becomes available for review after fulfillment.

Reviews

Submitted Review`klaviyo_webhook_submitted_review`

Fires when a product review is submitted with content and a rating.

Reviews

Submitted Rating`klaviyo_webhook_submitted_rating`

Fires when a product rating is submitted.

Reviews


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.