Klaviyo Integration

API integrations

What you need to know about Obello's Klaviyo integration.

Obello allows designers and marketers to create beautiful, on-brand HTML email templates. With Obello’s Klaviyo integration, users can publish completed email templates directly from Obello into Klaviyo via the Klaviyo API, with no manual HTML export required.

This document provides:

  1. Installation & Setup Guide
  2. Data Reference (following Klaviyo’s structure)
  3. How-To Use Cases
  4. Technical Notes & API Requirements
  5. Troubleshooting

1. Installation & Setup Guide

1.1 | Overview

Obello integrates with Klaviyo through secure API authentication. Once connected, users can publish email templates directly from the Obello editor into their Klaviyo account.

1.2 | Requirements

  • A Klaviyo account
  • A Private Klaviyo API key
  • An Obello user account with integration permissions
  • Klaviyo Email Template permissions enabled in Klaviyo

1.3 | Steps to Install & Connect


Step 1 — Obtain Your Klaviyo Private API Key

  1. Log in to Klaviyo
  2. Navigate to Account → Settings → API Keys
  3. Under Private API Keys, select [Create Private Key]
  4. Copy the key. You will need this to connect Obello

Important: You must grant:

  • Accounts: read
  • Templates: write
  • Templates: read

Step 2 — Connect Klaviyo in Obello

  1. Go to Obello Dashboard → Integrations
  2. Select Klaviyo Integration
  3. Click [Connect]
  4. Obello will validate your key by calling Klaviyo’s api/templates endpoint

If authentication is successful, you will see a confirmation:
“Your Klaviyo account is now connected to Obello.”

Step 3 — Enable Template Publishing

After connecting, Obello will activate:

  • Export to Klaviyo CTA in Email Editor
  • Template synchronization logs

Example UI Flow:

  1. User designs email → Click Export to Klaviyo
  2. Template is pushed directly to Klaviyo via API
  3. Success message is displayed

2. Data Reference

This section explains all data exchanged between Obello and Klaviyo.

2.1 | Template Object (Sent from Obello --> Klaviyo)

Obello publishes HTML Email Templates using Klaviyo’s Templates API:

Endpoint
POST https://a.klaviyo.com/api/templates/

Headers
Content-Type: application/json
Authorization: Klaviyo-API-Key {PRIVATE_API_KEY}
revision: 2023-10-15

Payload Structure Example
{
"data": {
"type": "template",
"attributes": {
"name": "Obello - Summer Promo Template",
"editor_type": "html",
"html": "<html> ... generated by Obello ... </html>"
}
}

2.2 | Fields Provided by Obello

FieldTypeDescriptionRequired
NameStringTemplate nameYes
Editor_typeStringHTMLYes
HTMLStringRendered HTML generated by ObelloYes

2.3 | Data Returned from Klaviyo to Obello

Once a template is successfully created:

{

"data": {

"id": "template_123ABC",

"type": "template",

"attributes": {

"name": "Obello - Summer Promo Template",

"created_at": "2024-03-20T10:22:00Z",

"updated_at": "2024-03-20T10:22:00Z"

}

}

}

Obello stores:

  1. Template ID
  2. Created timestamp
  3. Updated timestamp

*This is used for sync history and logs.

2.4 | Error Handling Response Examples

Missing API Key
{
"errors": [
{
"status": "401",
"detail": "Unauthorized - Invalid API Key"
}
]
}

Invalid Template HTML
{
"errors": [
{
"status": "400",
"detail": "HTML format invalid"
}
]
}

Obello surfaces these errors directly to users with a clear explanation.

3. Use Case: How To Publish Templates from Obello --> Klaviyo

Use Case 01: Publish a New Email Template

  1. Design email in Obello Editor
  2. User enters template name
  3. Click [Export to Klaviyo]
  4. Confirmation message displayed
    • Obello sends HTML via API
    • Template appears in Klaviyo → Content → Templates

User Benefits

  • Zero manual export/import
  • Always brand-consistent HTML
  • Faster campaign creation

Use Case 02: Update an Existing Klaviyo Template


If Obello detects that a Template ID already exists:

  1. Make design edits in Obello
  2. [Export template to Klaviyo]
  3. Obello calls:

PATCH /api/templates/{template_id}

Benefits

  • Easy version control
  • Eliminates duplicate templates

Use Case 03: Manage Template Publishing History

In Obello → Integration Logs, users can:

  • View the publish success status
  • View template IDs
  • Re-publish, or roll back
  • Confirm last sync time

Use Case 04: Team Workflow Integration

Cross-functional team roles:

  • Designers create HTML email templates in Obello
  • Marketers modify templates and publish directly to Klaviyo
  • Campaign managers use templates to fuel marketing campaigns

4. Technical Implementation Notes

Rate Limits

Obello respects Klaviyo rate limits:

  • 100 requests / second
  • Auto-backoff mechanism included

HTML Requirements

  • Obello templates follow:
  • Klaviyo-compatible HTML
  • Standard email-safe tags
  • Inline CSS for maximum compatibility

Security

  • API keys stored using AES-256 encryption
  • User tokens are never stored in logs
  • Connection can be revoked anytime from the Obello dashboard