Skip to content

Commit fd3f828

Browse files
author
markzegarelli
authored
Merge branch 'master' into DOC-204_papi_catalog
2 parents a72826f + 2c7af6c commit fd3f828

File tree

2 files changed

+322
-5
lines changed

2 files changed

+322
-5
lines changed

src/_data/catalog/destinations.yml

Lines changed: 273 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5246,9 +5246,95 @@ items:
52465246
summary: accepts device-mode data only from Analytics.js.
52475247
cmode_type: device-only
52485248
case: '2'
5249+
settings:
5250+
- name: accountNumber
5251+
display_name: Account Number
5252+
type: STRING
5253+
deprecated: false
5254+
required: true
5255+
string_validators:
5256+
regexp: ^\d+$
5257+
description: >-
5258+
You can find your Account Number by going to the [Crazy Egg Setup
5259+
Instructions](http://www.crazyegg.com/instructions) and clicking **I use
5260+
Segment.** Your account number will appear in bold. It should be a series
5261+
of numbers, like `00938301`.
5262+
settings: []
52495263
- display_name: Crisp
5250-
name: Crisp
52515264
slug: crisp
5265+
name: catalog/destinations/crisp
5266+
url: connections/destinations/catalog/crisp
5267+
description: Crisp is an all-in-one platform to connect with your customers.
5268+
hidden: false
5269+
status: PUBLIC
5270+
previous_names:
5271+
- Crisp
5272+
logo:
5273+
url: >-
5274+
https://public-segment-devcenter-production.s3.amazonaws.com/db6f4c77-470b-429c-b77a-77b1228ade63.svg
5275+
mark:
5276+
url: >-
5277+
https://public-segment-devcenter-production.s3.amazonaws.com/45cad587-47d4-4ada-a09d-c730242af27e.svg
5278+
categories:
5279+
- CRM
5280+
- Customer Success
5281+
- Email Marketing
5282+
- Marketing Automation
5283+
methods:
5284+
alias: false
5285+
group: false
5286+
identify: true
5287+
page_view: false
5288+
track: true
5289+
components:
5290+
- type: WEB
5291+
platforms:
5292+
browser: true
5293+
server: true
5294+
mobile: true
5295+
browserUnbundlingSupported: false
5296+
browserUnbundlingPublic: false
5297+
connection_modes:
5298+
device:
5299+
web: true
5300+
mobile: false
5301+
server: false
5302+
cloud:
5303+
web: false
5304+
mobile: false
5305+
server: false
5306+
summary: accepts device-mode data only from Analytics.js.
5307+
cmode_type: device-only
5308+
case: '2'
5309+
settings:
5310+
- name: apiKey
5311+
display_name: API Key
5312+
type: STRING
5313+
deprecated: false
5314+
required: true
5315+
string_validators:
5316+
regexp: '^.{8,}$'
5317+
description: >-
5318+
The API key is autoset when linking Crisp with Segment. Click "Connect to
5319+
Segment" in the Crisp plugins section
5320+
settings: []
5321+
- name: websiteId
5322+
display_name: Website ID
5323+
type: STRING
5324+
deprecated: false
5325+
required: false
5326+
string_validators:
5327+
regexp: ''
5328+
description: ''
5329+
settings: []
5330+
- display_name: Criteo App & Web Events
5331+
slug: criteo-app-web-events
5332+
name: catalog/destinations/criteo
5333+
url: connections/destinations/catalog/criteo-app-web-events
5334+
description: >-
5335+
Criteo uses state of the art machine learning to transform digital
5336+
advertising into a personal experience. Please Note: Our web integration
5337+
with Criteo is currently in Beta.
52525338
hidden: false
52535339
url: connections/destinations/catalog/crisp
52545340
previous_names:
@@ -13107,6 +13193,78 @@ items:
1310713193
Cloud Mode or send track events from one of our server side libraries. Use
1310813194
these fields to map your Segment track event names to Marketo Custom
1310913195
Activities. We'll only send events that you specify.
13196+
settings:
13197+
- name: marketoActivityId
13198+
display_name: Marketo Custom Activity ID
13199+
type: STRING
13200+
deprecated: false
13201+
required: true
13202+
string_validators:
13203+
regexp: '^[0-9]+$'
13204+
description: Enter the Marketo Custom Activity ID. This must be an Integer.
13205+
settings: []
13206+
- name: segmentProperty
13207+
display_name: Marketo Fields
13208+
type: MIXED
13209+
deprecated: false
13210+
required: false
13211+
description: Map your Segment properties to the Marketo Activity Fields
13212+
settings:
13213+
- name: segmentProperty
13214+
display_name: Segment Property Name
13215+
type: STRING
13216+
deprecated: false
13217+
required: true
13218+
string_validators:
13219+
regexp: ''
13220+
description: >-
13221+
Enter the Segment Property Name. This is case sensitive so make sure
13222+
the name matches exactly how you are passing it in your .track() call.
13223+
settings: []
13224+
- name: marketoAttributeName
13225+
display_name: Marketo Field Name
13226+
type: STRING
13227+
deprecated: false
13228+
required: true
13229+
string_validators:
13230+
regexp: ''
13231+
description: >-
13232+
Enter the Marketo Field name. Make sure to copy and paste the exact
13233+
API Name for your field as it appears in Marketo.
13234+
settings: []
13235+
- name: marketoAttributeType
13236+
display_name: Marketo Field Type
13237+
type: SELECT
13238+
deprecated: false
13239+
required: true
13240+
select_validators:
13241+
select_options:
13242+
- string
13243+
- boolean
13244+
- number
13245+
- date
13246+
description: Enter the Marketo Field type.
13247+
settings: []
13248+
- name: primaryKey
13249+
display_name: Set as Primary Key
13250+
type: BOOLEAN
13251+
deprecated: false
13252+
required: false
13253+
description: Mark this property as the Primary field in Marketo.
13254+
settings: []
13255+
- name: event
13256+
display_name: Segment Event Name
13257+
type: STRING
13258+
deprecated: false
13259+
required: true
13260+
string_validators:
13261+
regexp: ''
13262+
description: Enter the Segment Event Name.
13263+
settings: []
13264+
- name: traits
13265+
display_name: Marketo Custom Fields
13266+
type: MIXED
13267+
deprecated: false
1311013268
required: false
1311113269
- name: privateKey
1311213270
type: string
@@ -17102,7 +17260,120 @@ items:
1710217260
description: >-
1710317261
Use these fields to map your Segment event names to Responsys Supplemental
1710417262
Tables. We'll only send events and properties that you specify.
17105-
required: false
17263+
settings:
17264+
- name: columns
17265+
display_name: Columns
17266+
type: MIXED
17267+
deprecated: false
17268+
required: false
17269+
description: Map your Segment properties to Responsys Columns
17270+
settings:
17271+
- name: primaryKey
17272+
display_name: Set as Primary Key
17273+
type: BOOLEAN
17274+
deprecated: false
17275+
required: false
17276+
description: Mark this property as a Primary Key in Responsys.
17277+
settings: []
17278+
- name: columns
17279+
display_name: Segment Property Name
17280+
type: STRING
17281+
deprecated: false
17282+
required: true
17283+
string_validators:
17284+
regexp: ''
17285+
description: Enter the Segment Property Name.
17286+
settings: []
17287+
- name: fieldName
17288+
display_name: Responsys Column Name
17289+
type: STRING
17290+
deprecated: false
17291+
required: true
17292+
string_validators:
17293+
regexp: ''
17294+
description: Enter the Responsys column name.
17295+
settings: []
17296+
- name: fieldType
17297+
display_name: Responsys Column Type
17298+
type: SELECT
17299+
deprecated: false
17300+
required: true
17301+
select_validators:
17302+
select_options:
17303+
- CHAR
17304+
- STR25
17305+
- STR100
17306+
- STR500
17307+
- STR4000
17308+
- Number
17309+
- INTEGER
17310+
- TIMESTAMP
17311+
description: Enter the Responsys column type.
17312+
settings: []
17313+
- name: mapEmail
17314+
display_name: Map Email
17315+
type: BOOLEAN
17316+
deprecated: false
17317+
required: false
17318+
description: >-
17319+
Check this box if you want to automatically create and or map Segment's
17320+
`email` property (in `context.traits.email` or `properties.email`) as a
17321+
column in Responsys. Highly **recommended** if you are calling
17322+
`.identify()` with an `email` trait for anonymous users without
17323+
`userId`s.
17324+
settings: []
17325+
- name: mapUserId
17326+
display_name: Map Segment UserId
17327+
type: BOOLEAN
17328+
deprecated: false
17329+
required: false
17330+
description: >-
17331+
Check this box if you want to automatically create and or map Segment's
17332+
`userId` field as a column in Responsys. Highly **recommended** if you
17333+
want to connect records in your Profile Lists/Extension Tables with
17334+
records in this Supplemental Table.
17335+
settings: []
17336+
- name: folderName
17337+
display_name: Responsys Folder Name
17338+
type: STRING
17339+
deprecated: false
17340+
required: true
17341+
string_validators:
17342+
regexp: ''
17343+
description: >-
17344+
Optional. Enter a Responsys Folder Name where this Supplemental exists
17345+
or where you'd like one to be created. If this input is left blank, we
17346+
will fallback on the default Folder Name you've provided at the top
17347+
level settings.
17348+
settings: []
17349+
- name: suppName
17350+
display_name: Responsys Supplemental Table Name
17351+
type: STRING
17352+
deprecated: false
17353+
required: true
17354+
string_validators:
17355+
regexp: ''
17356+
description: Enter a Responsys Supplemental Table Name.
17357+
settings: []
17358+
- name: event
17359+
display_name: Segment Event Name
17360+
type: STRING
17361+
deprecated: false
17362+
required: true
17363+
string_validators:
17364+
regexp: ''
17365+
description: Enter the Segment Event Name.
17366+
settings: []
17367+
- name: useSegmentMsgId
17368+
display_name: Use Segment Message ID
17369+
type: BOOLEAN
17370+
deprecated: false
17371+
required: false
17372+
description: >-
17373+
Use Segment's `messageId` as one of the four Primary Keys to easily
17374+
ensure that you do not overwrite historical records in your Supplemental
17375+
Tables.
17376+
settings: []
1710617377
- name: folderName
1710717378
type: string
1710817379
defaultValue: ''
Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,50 @@
11
---
2-
title: 'Crisp Destination'
3-
hidden: true
4-
--- %}
2+
title: Crisp Destination
3+
rewrite: true
4+
---
5+
[Crisp](https://crisp.chat/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is an all-in-one solution to communicate with your customers using text-messaging.
6+
7+
This destination is maintained by Crisp. For any issues with the destination, [contact the Crisp Support team](mailto:[email protected]).
8+
9+
## Getting Started
10+
11+
{% include content/connection-modes.md %}
12+
13+
1. Go to the [Crisp Plugins page](app.crisp.chat).
14+
2. Search for the "Segment" plugin, click **Connect to Segment**.
15+
3. The Segment App opens in a new window. Log in to authenticate the connection from Crisp.
16+
4. Select the Workspace and Source to connect with Crisp.
17+
18+
## Supported methods
19+
20+
Crisp supports the following methods, as specified in the [Segment Spec](/docs/connections/spec/).
21+
22+
### Identify
23+
24+
Send [Identify](/docs/connections/spec/identify/) calls to create or update a User profile. The `email` trait is required to create new Users. For example:
25+
26+
```js
27+
analytics.identify('userId123', {
28+
name: 'John Doe',
29+
30+
phone: '012346789',
31+
avatar: 'https://pbs.twimg.com/profile_images/834424630630817795/TfyS4uXb_400x400.jpg'
32+
});
33+
```
34+
35+
### Track
36+
37+
Crisp adds [Track](/docs/connections/spec/track/) events to the User's profile events stream.
38+
39+
```js
40+
analytics.track('Completed Purchase', {
41+
revenue: 42.99,
42+
shippingMethod: '2-day',
43+
category: 'Conversion'
44+
});
45+
```
46+
> warning ""
47+
> Send an Identify call for any user who triggers Track calls. If Crisp receives a Track call for an unknown `userId`, the call is dropped.
48+
49+
50+

0 commit comments

Comments
 (0)