Inkit Destination

Inkit and Segment empower organizations to securely generate and distribute documents - both digitally as well as through direct mail. For example, automatically create and send electronic documents like invoices, reports, notices, and more through a magic link or e-delivery. Or generate and send documents for e-signature, storage, postcards, letters, and more, all powered by the Inkit integration for Segment.

Getting Started

Add the destination:

1. From the Destinations catalog page in your Segment workspace, click Add Destination.
2. Search for “Inkit” in the Destinations Catalog, and select the “Inkit” destination.
3. Choose which Source should send data to the “Inkit” destination.

Get the Inkit API Key:

1. Sign up and create an Inkit account.
2. Follow the instructions in the documentation to create an API key.
3. Enter the “API Key” in the “Inkit” destination settings in Segment.

To use a Template ID:

1. From the Destinations catalog page in your Segment workspace, click Add Destination.
2. Search for “Inkit” in the Destinations Catalog, and select the “Inkit” destination.
3. Choose which Source should send data to the “Inkit” destination.
4. Create a template in Word, PDF, HTML, Excel, or PowerPoint.
5. Copy the Template ID to the “Templates” tab in the Inkit web app.
6. Paste the id into the “template_id” field when setting up the Destination in Segment.

For more information, see Inkit documentation.

Expected Data

The merge fields in the template dictate what data you must pass to Inkit through the integration. The only must-have data point is the “template_id”.

For example, you might send a letter in which you need to include the recipient’s name, address, and so forth.

Identify

If you aren’t familiar with the Segment Spec, see the Identify method documentation to learn about what it does. An example call with Inkit would look like:

Expected Requirements:

analytics.identify('userId123', {
    template_id:"<template_id>", (required)
    first_name: "Nick", (required)
    last_name: "Fury", (optional)
    address_line_1: "1 Rocket Road", (required)
    address_line_2: "Suite 1", (optional)
    address_city: "Hawthorne", (required)
    address_state: "CA", (required)
    address_zip: "90250", (required)
    address_country: "US", (required)
});

Call Including Address Line 2 (apt number)

analytics.identify('userId123', {
    template_id:"<template_id>",
    address_line_2: "Suite 1"
});

Bare Minimum Call

analytics.identify('userId123', {
    template_id:"<template_id>"
});

Custom Fields Call

analytics.identify('userId123', {
    template_id:"<template_id>",
    email:"n.fury@shield.com",
    company:"SHIELD",
    phone:"3107099497",
    subscription: "premium",
    custom_field_example: "content"
});

All other fields are then added to the user’s profile as custom fields within Inkit’s dashboard.

Segment sends Identify calls to Inkit as an identify event.

SELECT COUNT(*) FROM destination_config WHERE destination_id = ‘54521fd525e721e32a72ee8f’ AND enabled = 1 AND id IN (SELECT config_id FROM destination_config_options_2 WHERE option_name = ‘canOmitAppsFlyerId’ AND value = ‘false’)

Engage

You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Engage sets that value to false.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.