6 added
6 removed
Original
2026-01-01
Modified
2026-03-10
1
-
<p><a>Klaviyo’s API</a>is core to our value proposition. Though we are a leader in <a>integrations</a>, we know we can’t build everything under the sun; that’s where our API comes in. By opening up Klaviyo to our developer community, we empower our partners and customers to build whatever they need: from a simple script to tie together 2 disparate sources of data, to a fully-fledged integration.</p>
1
+
<p><a>Klaviyo’s API</a>is core to our value proposition. Though we are a leader in<a>integrations</a>, we know we can’t build everything under the sun; that’s where our API comes in. By opening up Klaviyo to our developer community, we empower our partners and customers to build whatever they need: from a simple script to tie together 2 disparate sources of data, to a fully-fledged integration.</p>
2
<p>Our SDKs take this one step further, by offering our developers an intuitive and familiar interface for interacting with our API, in their language of choice.</p>
2
<p>Our SDKs take this one step further, by offering our developers an intuitive and familiar interface for interacting with our API, in their language of choice.</p>
3
<h3><strong>The challenge: scale + speed</strong></h3>
3
<h3><strong>The challenge: scale + speed</strong></h3>
4
<p>One of the challenges faced by<a>API-first</a>companies is ensuring that downstream tools keep pace with the API.</p>
4
<p>One of the challenges faced by<a>API-first</a>companies is ensuring that downstream tools keep pace with the API.</p>
5
<p>Consider the figure below:</p>
5
<p>Consider the figure below:</p>
6
<p>As you can imagine, developing a workflow to scalably generate these downstream tools becomes increasingly important as the scope of the API grows and the pace of API development accelerates.</p>
6
<p>As you can imagine, developing a workflow to scalably generate these downstream tools becomes increasingly important as the scope of the API grows and the pace of API development accelerates.</p>
7
<p>At Klaviyo, we’ve made a big investment into API automation. This means that any change to<a>our AP</a>I is immediately reflected in our downstream tools. This approach minimizes time to release and minimizes code divergence.</p>
7
<p>At Klaviyo, we’ve made a big investment into API automation. This means that any change to<a>our AP</a>I is immediately reflected in our downstream tools. This approach minimizes time to release and minimizes code divergence.</p>
8
<h4><strong><strong>OpenAPI specification</strong></strong></h4>
8
<h4><strong><strong>OpenAPI specification</strong></strong></h4>
9
-
<p>We have been able to do this by leveraging <a>OpenAPI</a>, a powerful, machine-readable standard for describing APIs.</p>
9
+
<p>We have been able to do this by leveraging<a>OpenAPI</a>, a powerful, machine-readable standard for describing APIs.</p>
10
<p>We use OpenAPI throughout the API development process: from mocking API prototypes at the product-development stage, to auto-generating a comprehensive OpenAPI specification in production.</p>
10
<p>We use OpenAPI throughout the API development process: from mocking API prototypes at the product-development stage, to auto-generating a comprehensive OpenAPI specification in production.</p>
11
<h4><strong>SDK generation with OpenAPI Generator</strong></h4>
11
<h4><strong>SDK generation with OpenAPI Generator</strong></h4>
12
-
<p>With an <a>OpenAPI spec</a>, we have a single source of truth that we can plug into a wide variety of <a>development tools</a>, available to both our engineering team and our global developer community: <a>SDKs</a>, <a>API docs</a>, <a>Postman Collection</a>, and much more.</p>
12
+
<p>With an<a>OpenAPI spec</a>, we have a single source of truth that we can plug into a wide variety of<a>development tools</a>, available to both our engineering team and our global developer community:<a>SDKs</a>,<a>API docs</a>,<a>Postman Collection</a>, and much more.</p>
13
-
<p>One of the most useful tools in our OpenAPI toolbox is <a>OpenAPI-Generator</a>; with this, we are able to generate SDKs that work right out of the box, using just our OpenAPI spec.</p>
13
+
<p>One of the most useful tools in our OpenAPI toolbox is<a>OpenAPI-Generator</a>; with this, we are able to generate SDKs that work right out of the box, using just our OpenAPI spec.</p>
14
<p>However, there are certain features that don’t come built into the base generators. Informed by our developer community, as well as our experience creating and consuming both APIs and SDKs, we built an additional layer onto our SDK automation pipeline, to add these features:</p>
14
<p>However, there are certain features that don’t come built into the base generators. Informed by our developer community, as well as our experience creating and consuming both APIs and SDKs, we built an additional layer onto our SDK automation pipeline, to add these features:</p>
15
<ul><li>Client- and endpoint-level authentication</li>
15
<ul><li>Client- and endpoint-level authentication</li>
16
<li>Retries</li>
16
<li>Retries</li>
17
<li>Timeouts</li>
17
<li>Timeouts</li>
18
<li>More intuitive namespace</li>
18
<li>More intuitive namespace</li>
19
</ul><p>By having our SDK handle much of the boilerplate code that our developers would otherwise have to write, we free them up to focus on what they do best: creatively building better customer experiences, at scale.</p>
19
</ul><p>By having our SDK handle much of the boilerplate code that our developers would otherwise have to write, we free them up to focus on what they do best: creatively building better customer experiences, at scale.</p>
20
<h3><strong>Get started building with our SDKs</strong></h3>
20
<h3><strong>Get started building with our SDKs</strong></h3>
21
-
<ul><li>Check out our full lineup of <a>SDKs</a> (<a>Python</a>, <a>PHP</a>, <a>Ruby</a>, <a>Node/JS</a>)</li>
21
+
<ul><li>Check out our full lineup of<a>SDKs</a>(<a>Python</a>,<a>PHP</a>,<a>Ruby</a>,<a>Node/JS</a>)</li>
22
-
<li>Read through our developer <a>guides</a> to level up from sandbox account to fully-fledged integration</li>
22
+
<li>Read through our developer<a>guides</a>to level up from sandbox account to fully-fledged integration</li>
23
</ul>
23
</ul>