How to Set Up a Webhook in Klaviyo to Create a Letter Using Stannp API

This guide explains how to use Klaviyo's webhook functionality to automate letter creation using the Stannp API.

Prerequisites

1. API Key: Obtain your Stannp API key from your Stannp account.
2. API Endpoint: Use the following endpoint for the webhook:
   https://api-us1.stannp.com/v1/letters/create
3. A Flow in Klaviyo: Create or open a flow in your Klaviyo account to integrate the webhook.
4. Recipient Data: Ensure that the necessary data (e.g., recipient name, address) is available in Klaviyo profiles or event properties.

Steps to Create the Webhook

Step 1: Create or Open a Flow in Klaviyo

1. Log in to your Klaviyo account.
2. Navigate to Flows in the left-hand sidebar.
3. Select an existing flow or click Create Flow to build a new one:
   • Add a trigger, such as "Placing an Order" or a custom event, depending on when you want the webhook to be sent.

Step 2: Add a Webhook Action

1. Within the flow editor, click + Add Action.
2. Select Webhook from the action list.

Step 3: Configure the Webhook

URL and Method

1. Set the Request URL to the following:

   https://api-us1.stannp.com/v1/letters/create?api_key=YOUR_API_KEY

   Replace YOUR_API_KEY with your Stannp API key.
2. Select POST as the HTTP method.

Step 4: Construct the Request Body

Add the parameters in JSON format. Depending on your use case, you must include either the template or file parameter in the body. Use Klaviyo’s dynamic tags to populate recipient data from profiles or event properties.

Example Body with Template:

{
"test": true,
"template": 12345,
"recipient": {
"title": "",
"firstname": "",
"lastname": "",
"address1": "",
"address2": "",
"city": "",
"postcode": "",
"country": ""
},
"tags": "invoice, priority",
"addons": "FIRST_CLASS",
"duplex": true,
"clearzone": true,
"post_unverified": false
}

{
"test": false,
"file": "https://example.com/sample_document.pdf",
"recipient": {
"firstname": "",
"lastname": "",
"address1": "",
"city": "",
"postcode": "",
"country": ""
},
"tags": "contract, premium",
"duplex": false,
"addons": "FIRST_CLASS"
}