Inkit Destination


Inkit connects to hundreds of printers with complete visibility. Instantly use global print infrastructure with Inkit’s developer friendly APIs, dashboards, and reporting. Connect, track, and manage critical business communications faster than ever before.

The Inkit Destination is in beta, which indicates ongoing development. To join the Inkit beta program, or if you have any feedback to help improve the Inkit Destination and its documentation, contact the Inkit support team.

Inkit maintains this destination. For any issues with the destination, contact the Inkit support team.

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. Go to the INKIT Integrations, find and copy the “API key”.
  2. 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. Go to the INKIT Templates, find the desired template.
  5. Click the three dots on the far right side and select “Copy Id”.
  6. Paste the id into the “template_id” field when setting up the destination.

For more information, see INKIT documentation.

Expected Data

Field Type Description
template_id string ID of the template from the Inkit UI (required)
first_name string The first name of the contact (optional but either first_name or last_name is required)
last_name string The last name of the contact (optional but either first_name or last_name is required)
email string The email address of the contact (optional)
company string The company name that the contact belongs to (optional)
phone string The phone number of the contact (optional)
address_line_1 string The primary line, or street address of the contact (64-character limit) (required)
address_line_2 string The apartment or suite number (optional)
address_city string The city of the contact’s address (required)
address_state string The two-letter (2) state code of the contact’s address (required)
address_zip string The ZIP Code of the contact’s address (required)
address_country string The two-letter (2) ISO alpha-2 country code of the contact’s address (required)

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:

note”” All address elements should be satisified within the segment’s user identity (exception of address_line_2 which is a custom entry)

Expected Requirements

analytics.identify('userId123', {
    template_id:"<template_id>", (required)
    first_name: "Elon", (required)
    last_name: "Musk", (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:"elon@spacex.com",
    company:"SpaceX",
    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.

Personas

You can send computed traits and audiences generated using Segment Personas to this destination as a user property. To learn more about Personas, contact us for 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, Personas 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), Personas sets that value to false.

When you first create an audience, Personas 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.

API Key

Please include the API key from Inkit

This page was last modified: 29 Sep 2020

Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account