The Paperplanes + Iterable integration lets you easily send direct mail and parcels as part of your digital engagement strategy.
Automatically trigger direct mail sends in Iterable journeys
To integrate Iterable and Paperplanes, follow these steps:
Contact Paperplanes and have them generate an API key and secret for you.
-
In Iterable, create a new journey webhook by navigating to Integrations > Journey Webhooks and clicking New Webhook. The Create journey webhook page will appear:
-
Configure the webhook:
Name: A name you can use to identify the webhook in Iterable.
Destination: Custom
Method: POST
Endpoint:
https://api.paperplaneslive.com/api/submit
Authentication: None
-
Add two Custom headers:
Name:
api-key
/ Value:<YOUR_PAPERPLANES_API_KEY>
Name:
api-secret
/ Value:<YOUR_PAPERPLANES_SECRET>
-
Body
Select JSON
-
For the content of the body, use JSON with the following structure:
{ "DestinationListId": 0, "Records": [ { "CustomerID": "...", "first_name": "...", "last_name": "...", "Address1": "...", "Address2": "...", "Address3": "...", "Address4": "...", "Address5": "...", "Postcode": "...", "AdditionalData": { ... } } ] }
These fields have the following definitions:
-
DestinationListId
- Required. Campaign ID. Supplied by Paperplanes. -
CustomerID
- Required. An email address or other unique user ID. -
first_name
- Required. The contact's first name. -
last_name
- Required. The contacts last name. -
Address1
- Required. Mailing address, line 1. -
Address2
- Mailing address, line 2. -
Address3
- Mailing address, line 3. -
Address4
- Mailing address, line 4. -
Address5
- Mailing address, line 5. -
Postcode
- Required. Postcode. -
AdditionalData
- An object that contains any additional data fields needed for the mailing.
Use Handlebars to map each property to a user profile field in your Iterable project. For example, if your project stores each contact's first name in a
firstName
field, enter:{ ... "first_name": "{{firstName}}" ... }
-
Click Create Webhook.
To integrate Iterable with Paperplanes, use this webhook in your journeys.