> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/klaviyo.md).

# Klaviyo

Connect Klaviyo marketing data, profiles, consent, events, and campaigns.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication  |
| --------- | --------------- |
| Klaviyo   | Private API Key |

#### Klaviyo

Connect to Klaviyo with a scoped private API key.

**Set up in Klaviyo**

1. Prepare the Klaviyo account or service that the workflow will access. Grant access to the required resources and operations.
2. **Private API Key:** Create a Custom private API key as a Klaviyo Owner or Admin. It needs accounts:read, profiles:write, lists:read, lists:write, subscriptions:write, events:write, segments:read, campaigns:read, and campaigns:write.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Klaviyo**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field   | Required | What to enter                                                                                                                                                                                                                                                                                     |
| --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Private API Key | Yes      | Create a Custom private API key as a Klaviyo Owner or Admin. It needs accounts:read, profiles:write, lists:read, lists:write, subscriptions:write, events:write, segments:read, campaigns:read, and campaigns:write. [Provider instructions](https://www.klaviyo.com/settings/account/api-keys/). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Klaviyo** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create or Update Profile

Create a Klaviyo profile or update an existing customer using a known identifier.

**Inputs**

| Field             | Type     | Required | Description                                               |
| ----------------- | -------- | -------- | --------------------------------------------------------- |
| Profile ID        | string   | No       | The existing Klaviyo profile to update.                   |
| Email             | string   | No       | The customer's email address.                             |
| Phone Number      | string   | No       | The customer's phone number in international format.      |
| External ID       | string   | No       | Your own stable customer identifier.                      |
| First Name        | string   | No       | The customer's first name.                                |
| Last Name         | string   | No       | The customer's last name.                                 |
| Organization      | string   | No       | The company or organization associated with the customer. |
| Custom Properties | textarea | No       | Additional profile fields as a JSON object.               |

**Outputs**

| Field      | Type    | Description                        |
| ---------- | ------- | ---------------------------------- |
| Profile ID | string  | The Klaviyo profile identifier.    |
| Created    | boolean | Whether a new profile was created. |
| Profile    | object  | The profile returned by Klaviyo.   |

#### Subscribe Profile to List

Subscribe one profile to a Klaviyo list for email, SMS, or both.

**Inputs**

| Field              | Type            | Required | Description                                                                                     |
| ------------------ | --------------- | -------- | ----------------------------------------------------------------------------------------------- |
| List               | select (string) | Yes      | The Klaviyo list that should receive the subscriber. Options load from the selected connection. |
| Email              | string          | No       | The email address being subscribed.                                                             |
| Phone Number       | string          | No       | The mobile number being subscribed.                                                             |
| Subscribe to Email | boolean         | Yes      | Record consent for email marketing. Default: false.                                             |
| Subscribe to SMS   | boolean         | Yes      | Record consent for SMS marketing. Default: false.                                               |

**Outputs**

| Field    | Type    | Description                                    |
| -------- | ------- | ---------------------------------------------- |
| Accepted | boolean | Whether Klaviyo accepted the subscription job. |
| List ID  | string  | The target Klaviyo list.                       |

#### Create Event

Track a customer event in Klaviyo for flows and analytics.

**Inputs**

| Field              | Type     | Required | Description                                                 |
| ------------------ | -------- | -------- | ----------------------------------------------------------- |
| Event Name         | string   | Yes      | The event or metric name shown in Klaviyo.                  |
| Klaviyo Profile ID | string   | Yes      | The profile that performed the event.                       |
| Event Properties   | textarea | No       | Event details as a JSON object.                             |
| Unique Event ID    | string   | Yes      | A stable identifier that prevents duplicate event creation. |

**Outputs**

| Field           | Type    | Description                                        |
| --------------- | ------- | -------------------------------------------------- |
| Accepted        | boolean | Whether Klaviyo accepted the event for processing. |
| Unique Event ID | string  | The idempotency value submitted with the event.    |

#### List Segments

Find audience segments in Klaviyo with bounded pagination.

**Inputs**

| Field               | Type    | Required | Description                                                                      |
| ------------------- | ------- | -------- | -------------------------------------------------------------------------------- |
| Segment Name        | string  | No       | Only return a segment with this exact name.                                      |
| Maximum Results     | integer | No       | The maximum number of segments to return. Minimum: 1. Maximum: 100. Default: 50. |
| Continuation Cursor | string  | No       | Continue a previous segment listing.                                             |

**Outputs**

| Field       | Type          | Description                               |
| ----------- | ------------- | ----------------------------------------- |
| Segments    | object\_array | The matching Klaviyo segments.            |
| Next Cursor | string        | The cursor for the next page of segments. |

#### Send Campaign

Send an existing draft Klaviyo campaign to its configured audience.

**Inputs**

| Field          | Type            | Required | Description                                                                                |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------------------------ |
| Channel        | select (string) | Yes      | The campaign channel to browse. Available values: Email, SMS, Mobile Push. Default: email. |
| Draft Campaign | select (string) | Yes      | The draft campaign to send. Options load from the selected connection.                     |
| Confirm Send   | boolean         | Yes      | Confirm that this campaign should be sent now. Default: false.                             |

**Outputs**

| Field       | Type   | Description                                |
| ----------- | ------ | ------------------------------------------ |
| Campaign ID | string | The campaign Klaviyo accepted for sending. |
| Status      | string | The initial campaign send status.          |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/klaviyo.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
