360005640574

Inkit + Segment Integration

  • Updated

Automate orders with Segment's Connection product. Inkit partners with Segment, a Customer Data Platform (CDP) to collect & forward data to 300+ marketing and analytics tools.

Use Inkit and Segment to sync your vendor processes. Automatically send orders (swag, gifts, postcards, letters, etc.) as seamlessly as sending emails. Using Inkit, orders are sent to customers based on actions or events within Segment to acquire, re-engage, and communicate efficiently and effectively. The Inkit destination can be set up once you have a pre-existing Segment account set up.

Getting Started

Adding Destination

  1. From the Destinations catalog page in the Segment App, 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.

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.

TEMPLATE ID

  1. From the Destinations catalog page in the Segment App, 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. Select 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 additional assistance see INKIT documentation for getting keys and ID’s

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, take a look at the Identify method documentation to learn about what it does. An example call with Inkit would look like:

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 additional 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.

 

If you'd like to send Postcards, use the following guide: Inkit Postcards API.

If you'd like to send Letters, use the following guide: Inkit Letters API.