Skip to content

Commit c13b259

Browse files
author
markzegarelli
authored
Merge pull request #1853 from segmentio/doc-314_customer-io-actions
Customer.io (Actions)
2 parents e5f3fdd + 492633f commit c13b259

File tree

3 files changed

+171
-0
lines changed

3 files changed

+171
-0
lines changed

‎src/_data/actions/customer-io.yml

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
settings:
2+
- category: Connection Settings
3+
settings:
4+
- name: API Key (required)
5+
description: Your Customer.io API Key. This can be found on the [API Credentials Page](https://fly.customer.io/settings/api_credentials){:target="_blank"}.
6+
default:
7+
- name: Site ID (required)
8+
description: Your Customer.io site Key. This can be found on the [API Credentials Page](https://fly.customer.io/settings/api_credentials){:target="_blank"}.
9+
default:
10+
actions:
11+
- action: Track Event
12+
blurb: Track an event for a known person.
13+
fields:
14+
- name: Event Name (required)
15+
description: The name of the event.
16+
default: event
17+
- name: Person ID
18+
description: The ID of the person who triggered the event.
19+
default: userId
20+
- name: Anonymous ID
21+
description: The Anonymous ID of the person who triggered the event.
22+
default: anonymousId
23+
- name: Event Type
24+
description: Override the event type. For example, "page".
25+
default: type
26+
- name: Data
27+
description: Any customer data to include with the event.
28+
default: properties
29+
- action: Create or Update Person
30+
blurb: Update a person in Customer.io or create them if they don't exist.
31+
fields:
32+
- name: Person ID (required)
33+
description: The identifier used to uniquely identify a person in Customer.io
34+
default: userId
35+
- name: Email Address (required)
36+
description: The email address of the person.
37+
default: traits.userId
38+
- name: Anonymous ID
39+
description: The Anonymous ID to uniquely identify a person in Customer.io.
40+
default: anonymousId
41+
- name: Created At
42+
description: The timestamp for when this person was created.
43+
default: timestamp
44+
- name: Custom Attributes
45+
description: Optional custom attributes for this person. When you update a person, attributes are added and not removed.
46+
default: traits
47+
- action: Create or Update Device
48+
blurb: Update a person's device in Customer.io, or create it if it doesn't exist.
49+
fields:
50+
- name: Person ID (required)
51+
description: The ID of the person this device belongs to.
52+
default: userId
53+
- name: Device ID (required)
54+
description: The unique ID for the device from which the event was sent.
55+
default: context.device.id
56+
- name: Platform (required)
57+
description: The platform of the device.
58+
default: context.device.type
59+
- name: Last Used
60+
description: The timestamp for when the device was last used.
61+
default: timestamp
62+
- action: Track Anonymous Event
63+
blurb: Track an event not tied to a known person.
64+
fields:
65+
- name: Event Name (required)
66+
description: The name of the event.
67+
default: event
68+
- name: Data
69+
description: Custom data to include with the event. If `recipient`, `from_address`, or `reply_to` are sent, they will override settings on any campaings triggered by this event. `recipient` is required if the event is used to trigger a campaign.
70+
default: properties
71+
config:
72+
- category: Connection Settings
73+
settings:
74+
- name: API Key
75+
connection_mode:
76+
- cloud
77+
- device-web
78+
configurable: true
79+
location:
80+
notes: Set the API key as a connection setting during initial configuration, or on the Settings tab.
81+
- name: Customer.io Datacenter
82+
connection_mode:
83+
- cloud
84+
- device-web
85+
configurable: false
86+
location:
87+
notes: Customer.io Data Center is not needed in Customer.io (Actions)
88+
- name: Site ID
89+
connection_mode:
90+
- cloud
91+
- device-web
92+
configurable: true
93+
location:
94+
notes: Set the Site ID as a connection setting during initial configuration, or on the Settings tab.
95+
- name: Connection Mode
96+
connection_mode:
97+
- cloud
98+
- device-web
99+
configurable: false
100+
location:
101+
notes: Customer.io (Actions) supports cloud-mode.
102+
- category: Other Settings
103+
settings:
104+
- name: Convert to Unix Time
105+
connection_mode:
106+
- cloud
107+
- device-web
108+
configurable: false
109+
location:
110+
notes: tbd

‎src/connections/destinations/catalog/actions-customer-io/index.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: Customer.io (Actions) Destination
3+
hide-personas-partial: true
4+
hide-boilerplate: true
5+
hide-dossier: true
6+
hidden: true
7+
published: false
8+
---
9+
{% include content/plan-grid.md name="actions" %}
10+
11+
[Customer.io](https://customer.io/){:target="_blank"} lets you send automated email, push, SMS, letters, and webhooks based on your customer's activities in your app or product. It makes conversion tracking, optimization and remarketing easier.
12+
13+
> info ""
14+
> This document is about a feature which is in beta. This means that the Destination Actions are in active development, and some functionality may change before it becomes generally available
15+
16+
17+
> success ""
18+
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Braze Segment destination. There's also a page about the [non-Actions Customer.io destination](/docs/connections/destinations/catalog/customer-io/). Both of these destinations receives data _from_ Segment. There's also the [Customer.io source](/docs/connections/sources/catalog/cloud-apps/customer-io/), which sends data _to_ Segment!
19+
20+
## Benefits of Customer.io (Actions) vs Customer.io classic
21+
22+
- **Track an anonymous event**. Track events from users who are not yet known to Customer.io. If you have the Customer.io *event merging* feature enabled, Customer.io associates all incoming events that share an `anonymous_id` received in the last 30 days.
23+
24+
## Getting started
25+
26+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
27+
2. Find the Destinations Actions item in the left navigation, and click it.
28+
3. Select Customer.io (Actions).
29+
4. Click **Configure Actions Customer.io**.
30+
5. Select an existing Source to connect to Customer.io (Actions).
31+
6. Enter the **API Key** and **Site ID**. Find these values on the [Customer.io API Credentials Page](https://fly.customer.io/settings/api_credentials){:target="_blank"}.
32+
7. Select **Quick Setup** to start with pre-populated subscriptions, or **Customized Setup** to configure each action from scratch. Click **Configure Actions**.
33+
34+
## Prebuilt subscriptions
35+
36+
| Subscription Name | Trigger | Customer.io Action |
37+
| ----------------------- | --------------------------------------------------------------------- | ----------------------- |
38+
| Track Event | All **Track** calls from the connected source. | Track Event |
39+
| Create or Update Person | All **Identify** calls from the connected source. | Create or Update Person |
40+
| Create or Update Device | All **Track** calls where the Event Name is `Application Installed`. | Create or Update Device |
41+
42+
## Available Customer.io actions
43+
44+
Build your own subscription. Combine the supported [triggers](/docs/connections/destinations/actions/#components-of-a-destination-action) with the following Customer.io-supported actions:
45+
46+
- [Track Event](#track-event)
47+
- [Create or Update Person](#create-or-update-person)
48+
- [Create or Update Device](#create-or-update-device)
49+
- [Track Anonymous Event](#track-anonymous-event)
50+
51+
{% include components/actions-fields.html name="customer-io" %}
52+
53+
54+
## Migration from Customer.io classic
55+
56+
Keep the following in mind if you plan to move to Customer.io (Actions) from the classic Customer.io destination.
57+
{% include components/actions-map-table.html name="customer-io" %}

‎src/connections/destinations/catalog/customer-io/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,10 @@ For that, you need to make the following calls:
165165
}
166166
```
167167

168+
168169
## Application Opened
169170

171+
170172
[Application Opened](/docs/connections/spec/mobile/#application-opened) events will add or update a device in the person's Customer.io profile using the same endpoint as above. If a device already exists, Customer.io will update its `last_used_at` timestamp. Again, make sure you pass a device token in your event payload using a `context.device.token` property. See more on [Contextual properties](/docs/connections/spec/common/#context).
171173

172174
{% comment %} api-example '{
@@ -203,8 +205,10 @@ For that, you need to make the following calls:
203205
}
204206
```
205207

208+
206209
## Application Uninstalled
207210

211+
208212
[Application Uninstalled](/docs/connections/spec/mobile/#application-installed) events will remove the device from the person's Customer.io profile using [this](https://customer.io/docs/api/#apitrackcustomersdevices_delete) API endpoint. Note, you must pass a device token in your event payload using a `context.device.token` property. See more on [Contextual properties](/docs/connections/spec/common/#context).
209213

210214

0 commit comments

Comments
 (0)