Klaviyo
Overview
Pre-built tooling
✅ Authorization
| Tools | Status |
|---|---|
| Pre-built authorization (API Key) | ✅ |
| Pre-built authorization UI | ✅ |
| Custom authorization UI | ✅ |
| End-user authorization guide | ✅ |
| Expired credentials detection | ✅ |
✅ Read & write data
| Tools | Status |
|---|---|
| Pre-built integrations | ✅ |
| API unification | ✅ |
| 2-way sync | ✅ |
| Webhooks from Tenklo on data modifications | ✅ |
| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: <48h) |
| Proxy requests | ✅ |
✅ Observability & data quality
| Tools | Status |
|---|---|
| HTTP request logging | ✅ |
| End-to-end type safety | ✅ |
| Data runtime validation | ✅ |
| OpenTelemetry export | ✅ |
| Slack alerts on errors | ✅ |
| Integration status API | ✅ |
✅ Customization
| Tools | Status |
|---|---|
| Create or customize use-cases | ✅ |
| Pre-configured pagination | 🚫 (time to contribute: <48h) |
| Pre-configured rate-limit handling | 🚫 (time to contribute: <48h) |
| Per-customer configurations | ✅ |
Others
| Function name | Description | Type | Source code |
|---|---|---|---|
add-profiles-to-list | Add profiles to a list. | Action | 🔗 Github |
assign-template-to-campaign-message | Assign a reusable template's content to a campaign message. | Action | 🔗 Github |
bulk-import-profiles | Bulk-import profiles, optionally onto a list. | Action | 🔗 Github |
create-campaign | Create a draft email or SMS campaign | Action | 🔗 Github |
create-catalog-category | Create a catalog category. | Action | 🔗 Github |
create-catalog-item | Create a catalog item (product). | Action | 🔗 Github |
create-catalog-variant | Create a variant of a catalog item. | Action | 🔗 Github |
create-coupon-code | Create a unique coupon code under a coupon | Action | 🔗 Github |
create-coupon | Create a coupon. | Action | 🔗 Github |
create-event | Create an event | Action | 🔗 Github |
create-image | Upload an image from a URL. | Action | 🔗 Github |
create-list | Create a list. | Action | 🔗 Github |
create-profile | Create a profile. | Action | 🔗 Github |
create-segment | Create a segment from a condition definition. | Action | 🔗 Github |
create-tag-group | Create a tag group. | Action | 🔗 Github |
create-tag | Create a tag. | Action | 🔗 Github |
create-template | Create an HTML email template. | Action | 🔗 Github |
delete-campaign | Delete a campaign. | Action | 🔗 Github |
delete-catalog-category | Delete a catalog category | Action | 🔗 Github |
delete-catalog-item | Delete a catalog item. | Action | 🔗 Github |
delete-catalog-variant | Delete a catalog variant. | Action | 🔗 Github |
delete-coupon-code | Delete a coupon code. | Action | 🔗 Github |
delete-coupon | Delete a coupon. | Action | 🔗 Github |
delete-flow | Delete a flow. | Action | 🔗 Github |
delete-list | Delete a list. | Action | 🔗 Github |
delete-segment | Delete a segment. | Action | 🔗 Github |
delete-tag-group | Delete a tag group. | Action | 🔗 Github |
delete-tag | Delete a tag. | Action | 🔗 Github |
delete-template | Delete a template. | Action | 🔗 Github |
get-campaign | Retrieve a campaign. | Action | 🔗 Github |
get-image | Retrieve an image. | Action | 🔗 Github |
get-list | Retrieve a list. | Action | 🔗 Github |
get-profile | Retrieve a profile. | Action | 🔗 Github |
get-segment | Retrieve a segment. | Action | 🔗 Github |
get-template | Retrieve a template. | Action | 🔗 Github |
list-campaigns | List campaigns. | Action | 🔗 Github |
list-catalog-categories | List catalog categories. | Action | 🔗 Github |
list-catalog-items | List catalog items. | Action | 🔗 Github |
list-catalog-variants | List catalog item variants. | Action | 🔗 Github |
list-coupon-codes | List coupon codes. | Action | 🔗 Github |
list-coupons | List coupons. | Action | 🔗 Github |
list-events | List events. | Action | 🔗 Github |
list-flows | List flows. | Action | 🔗 Github |
list-forms | List forms. | Action | 🔗 Github |
list-images | List images. | Action | 🔗 Github |
list-lists | List lists. | Action | 🔗 Github |
list-metrics | List metrics. | Action | 🔗 Github |
list-profiles | List profiles. | Action | 🔗 Github |
list-reviews | List product reviews. | Action | 🔗 Github |
list-segments | List segments. | Action | 🔗 Github |
list-tag-groups | List tag groups. | Action | 🔗 Github |
list-tags | List tags. | Action | 🔗 Github |
list-templates | List templates. | Action | 🔗 Github |
list-webhooks | List webhook subscriptions. | Action | 🔗 Github |
merge-profiles | Merge one profile into another. | Action | 🔗 Github |
query-campaign-values-report | Query aggregate performance metrics for campaigns. | Action | 🔗 Github |
query-metric-aggregates | Query aggregated event data for a metric | Action | 🔗 Github |
remove-profiles-from-list | Remove profiles from a list. | Action | 🔗 Github |
request-profile-deletion | Submit a GDPR/CCPA data-privacy deletion request for a profile. | Action | 🔗 Github |
send-campaign | Send a campaign immediately. | Action | 🔗 Github |
subscribe-profiles | Subscribe profiles to email/SMS marketing on a list. | Action | 🔗 Github |
unsubscribe-profiles | Unsubscribe profiles from email/SMS marketing on a list. | Action | 🔗 Github |
update-campaign | Update a campaign's name, audiences, or send strategy. | Action | 🔗 Github |
update-flow-status | Update a flow's status (draft/manual/live/archived). | Action | 🔗 Github |
update-list | Update a list. | Action | 🔗 Github |
update-profile | Update a profile | Action | 🔗 Github |
update-segment | Update a segment's name or definition. | Action | 🔗 Github |
update-tag | Rename a tag. | Action | 🔗 Github |
update-template | Update a template. | Action | 🔗 Github |
campaigns | Sync campaigns. | Sync | 🔗 Github |
catalog-categories | Sync catalog categories. | Sync | 🔗 Github |
catalog-items | Sync catalog items (products) | Sync | 🔗 Github |
coupon-codes | Sync coupon codes. | Sync | 🔗 Github |
coupons | Sync coupons. | Sync | 🔗 Github |
events | Sync events. | Sync | 🔗 Github |
flows | Sync flows. | Sync | 🔗 Github |
forms | Sync forms. | Sync | 🔗 Github |
images | Sync images. | Sync | 🔗 Github |
lists | Sync lists. | Sync | 🔗 Github |
metrics | Sync metrics. | Sync | 🔗 Github |
profiles | Sync profiles. | Sync | 🔗 Github |
reviews | Sync product reviews | Sync | 🔗 Github |
segments | Sync segments. | Sync | 🔗 Github |
tags | Sync tags. | Sync | 🔗 Github |
templates | Sync templates. | Sync | 🔗 Github |
Access requirements
| Pre-Requisites | Status | Comment |
|---|---|---|
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ |
Setup guide
No setup guide yet.
Need help getting started? Get help in the community.
Contribute improvements to the setup guide by editing this page
Useful links
- How to generate private & public API keys in your Klaviyo account
- API docs
- API Key rate limiting
- API Key auth related docs
- API Key scopes
- How to generate an OAuth application
- OAuth related docs
- List of OAuth scopes
Contribute useful links by editing this page
API gotchas
- For
API_KEYauth mode,Klaviyouses Public and Private API Keys to access different endpoints. Endpoints that begin with/apineed to be authenticated with the private API key, while endpoints that begin with/clientneed to be authenticated using the public API key. - If you want to use a different API version than the default one set in Tenklo you can override the
revisionby adding in the necessary header. For more details check Klaviyo API versioning - Rate limiting in
klaviyo-oauthis different from the standard API rate limiting. For more details check klaviyo-oauth rate limits
Contribute API gotchas by editing this page
Connect to Klaviyo
Guide to connect to Klaviyo using Tenklo Connect.