Skip to content

Commit b969577

Browse files
authored
Merge pull request #4663 from segmentio/thomas/inkit
update inkit docs per partner request
2 parents e02d4b7 + a21cc12 commit b969577

File tree

1 file changed

+22
-22
lines changed
  • src/connections/destinations/catalog/inkit

1 file changed

+22
-22
lines changed

src/connections/destinations/catalog/inkit/index.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,38 @@ title: Inkit Destination
33
rewrite: true
44
id: 5f0746ced1c79b49ddee49fd
55
---
6-
[Inkit](https://inkit.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) 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.
7-
8-
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](mailto:[email protected]).
6+
[Inkit](https://inkit.com){:target="_blank"} empowers organizations to securely generate and distribute documents - both digitally as well as through direct mail.
7+
For example, automatically create and send electronic documents like invoices, reports, notices, and more using 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.
98

109
> note ""
11-
> Inkit maintains this destination. For any issues with the destination, [contact the Inkit support team](mailto:[email protected]).
12-
10+
> Inkit maintains this destination. For any issues with the destination, [email the Inkit support team](mailto:[email protected]).
1311
1412
## Getting Started
1513

1614
Add the destination:
1715

1816
1. From the Destinations catalog page in your Segment workspace, click **Add Destination**.
19-
2. Search for "INKIT" in the Destinations Catalog, and select the "INKIT" destination.
20-
3. Choose which Source should send data to the "INKIT" destination.
17+
2. Search for "Inkit" in the Destinations Catalog, and select the "Inkit" destination.
18+
3. Choose which Source should send data to the "Inkit" destination.
2119

2220
Get the Inkit API Key:
2321

24-
1. Go to the [INKIT Integrations](https://app.inkit.io/#/account/integrations), find and copy the "API key".
25-
2. Enter the "API Key" in the "INKIT" destination settings in Segment.
22+
1. [Sign up](https://app.inkit.com/auth-init){:target="_blank"} and create an Inkit account.
23+
2. Follow [the instructions to create an API key](https://docs.inkit.com/docs/add-an-api-key-to-your-account){:target="_blank"}.
24+
3. Enter the “API Key” in the “Inkit” destination settings in Segment.
25+
2626

2727
To use a Template ID:
2828

29-
1. From the Destinations catalog page in your Segment workspace, click **Add Destination**.
30-
2. Search for "INKIT" in the Destinations Catalog, and select the "INKIT" destination.
31-
3. Choose which Source should send data to the "INKIT" destination.
32-
4. Go to the [INKIT Templates](https://app.inkit.io/#/templates), find the desired template.
33-
5. Click the three dots on the far right side and select "Copy Id".
34-
6. Paste the id into the "template_id" field when setting up the destination.
29+
1. From the Destinations catalog page in your Segment workspace, click Add Destination.
30+
2. Search for “Inkit” in the Destinations Catalog, and select the “Inkit” destination.
31+
3. Choose which Source should send data to the “Inkit” destination.
32+
4. [Create a template](https://docs.inkit.com/docs/create-a-template) in Word, PDF, HTML, Excel, or PowerPoint.
33+
5. Copy the Template ID to the “Templates” tab in the Inkit web app.
34+
6. Paste the id into the “template_id” field when setting up the Destination in Segment.
35+
3536

36-
For more information, see INKIT [documentation](https://docs.inkit.com/docs/inkit-postcards-api).
37+
For more information, see the Inkit [documentation](https://docs.inkit.com/docs/welcome-to-inkit){:target="_blank"}.
3738

3839
## Expected Data
3940

@@ -61,14 +62,13 @@ If you aren't familiar with the Segment Spec, see the [Identify method documenta
6162
> note""
6263
> All address elements should be satisified within the segment's user identity
6364
(exception of address_line_2 which is a custom entry)
64-
6565
Expected Requirements
6666

6767
```js
6868
analytics.identify('userId123', {
6969
template_id:"<template_id>", (required)
70-
first_name: "Elon", (required)
71-
last_name: "Musk", (optional)
70+
first_name: "Nick", (required)
71+
last_name: "Fury", (optional)
7272
address_line_1: "1 Rocket Road", (required)
7373
address_line_2: "Suite 1", (optional)
7474
address_city: "Hawthorne", (required)
@@ -99,8 +99,8 @@ Custom Fields Call
9999
```js
100100
analytics.identify('userId123', {
101101
template_id:"<template_id>",
102-
email:"elon@spacex.com",
103-
company:"SpaceX",
102+
email:"n.fury@shield.com",
103+
company:"SHIELD",
104104
phone:"3107099497",
105105
subscription: "premium",
106106
custom_field_example: "content"
@@ -109,4 +109,4 @@ analytics.identify('userId123', {
109109

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

112-
Segment sends Identify calls to INKIT as an `identify` event.
112+
Segment sends Identify calls to Inkit as an `identify` event.

0 commit comments

Comments
 (0)