Merge pull request #1682 from segmentio/crisp-docs

Crisp documentation

Author: markzegarelli

src/_data/catalog/destinations.yml

@@ -5684,6 +5684,73 @@ items:
       Segment.** Your account number will appear in bold. It should be a series
       of numbers, like `00938301`.
     settings: []
+- display_name: Crisp
+  slug: crisp
+  name: catalog/destinations/crisp
+  url: connections/destinations/catalog/crisp
+  description: Crisp is an all-in-one platform to connect with your customers.
+  hidden: false
+  status: PUBLIC
+  previous_names:
+  - Crisp
+  logo:
+    url: >-
+      https://public-segment-devcenter-production.s3.amazonaws.com/db6f4c77-470b-429c-b77a-77b1228ade63.svg
+  mark:
+    url: >-
+      https://public-segment-devcenter-production.s3.amazonaws.com/45cad587-47d4-4ada-a09d-c730242af27e.svg
+  categories:
+  - CRM
+  - Customer Success
+  - Email Marketing
+  - Marketing Automation
+  methods:
+    alias: false
+    group: false
+    identify: true
+    page_view: false
+    track: true
+  components:
+  - type: WEB
+  platforms:
+    browser: true
+    server: true
+    mobile: true
+  browserUnbundlingSupported: false
+  browserUnbundlingPublic: false
+  connection_modes:
+    device:
+      web: true
+      mobile: false
+      server: false
+    cloud:
+      web: false
+      mobile: false
+      server: false
+    summary: accepts device-mode data only from Analytics.js.
+    cmode_type: device-only
+    case: '2'
+  settings:
+  - name: apiKey
+    display_name: API Key
+    type: STRING
+    deprecated: false
+    required: true
+    string_validators:
+      regexp: '^.{8,}$'
+    description: >-
+      The API key is autoset when linking Crisp with Segment. Click "Connect to
+      Segment" in the Crisp plugins section
+    settings: []
+  - name: websiteId
+    display_name: Website ID
+    type: STRING
+    deprecated: false
+    required: false
+    string_validators:
+      regexp: ''
+    description: ''
+    settings: []
 - display_name: Criteo App & Web Events
   slug: criteo-app-web-events
   name: catalog/destinations/criteo
@@ -14611,26 +14678,6 @@ items:
       required: false
       description: Map your Segment properties to the Marketo Activity Fields
       settings:
-      - name: marketoAttributeType
-        display_name: Marketo Field Type
-        type: SELECT
-        deprecated: false
-        required: true
-        select_validators:
-          select_options:
-          - string
-          - boolean
-          - number
-          - date
-        description: Enter the Marketo Field type.
-        settings: []
-      - name: primaryKey
-        display_name: Set as Primary Key
-        type: BOOLEAN
-        deprecated: false
-        required: false
-        description: Mark this property as the Primary field in Marketo.
-        settings: []
       - name: segmentProperty
         display_name: Segment Property Name
         type: STRING
@@ -14653,6 +14700,26 @@ items:
           Enter the Marketo Field name. Make sure to copy and paste the exact
           API Name for your field as it appears in Marketo.
         settings: []
+      - name: marketoAttributeType
+        display_name: Marketo Field Type
+        type: SELECT
+        deprecated: false
+        required: true
+        select_validators:
+          select_options:
+          - string
+          - boolean
+          - number
+          - date
+        description: Enter the Marketo Field type.
+        settings: []
+      - name: primaryKey
+        display_name: Set as Primary Key
+        type: BOOLEAN
+        deprecated: false
+        required: false
+        description: Mark this property as the Primary field in Marketo.
+        settings: []
     - name: event
       display_name: Segment Event Name
       type: STRING
@@ -19202,6 +19269,22 @@ items:
       required: false
       description: Map your Segment properties to Responsys Columns
       settings:
+      - name: primaryKey
+        display_name: Set as Primary Key
+        type: BOOLEAN
+        deprecated: false
+        required: false
+        description: Mark this property as a Primary Key in Responsys.
+        settings: []
+      - name: columns
+        display_name: Segment Property Name
+        type: STRING
+        deprecated: false
+        required: true
+        string_validators:
+          regexp: ''
+        description: Enter the Segment Property Name.
+        settings: []
       - name: fieldName
         display_name: Responsys Column Name
         type: STRING
@@ -19228,22 +19311,6 @@ items:
           - TIMESTAMP
         description: Enter the Responsys column type.
         settings: []
-      - name: primaryKey
-        display_name: Set as Primary Key
-        type: BOOLEAN
-        deprecated: false
-        required: false
-        description: Mark this property as a Primary Key in Responsys.
-        settings: []
-      - name: columns
-        display_name: Segment Property Name
-        type: STRING
-        deprecated: false
-        required: true
-        string_validators:
-          regexp: ''
-        description: Enter the Segment Property Name.
-        settings: []
     - name: mapEmail
       display_name: Map Email
       type: BOOLEAN

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

@@ -0,0 +1,49 @@
+---
+title: Crisp Destination
+rewrite: true
+---
+[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.
+
+This destination is maintained by Crisp. For any issues with the destination, [contact the Crisp Support team](mailto:[email protected]).
+
+## Getting Started
+
+{% include content/connection-modes.md %} 
+
+1. Go to the [Crisp Plugins page](app.crisp.chat).
+2. Search for the "Segment" plugin, click **Connect to Segment**.
+3. The Segment App opens in a new window. Log in to authenticate the connection from Crisp.
+4. Select the Workspace and Source to connect with Crisp.
+
+### Supported methods
+
+Crisp supports the following methods, as specified in the [Segment Spec](/docs/connections/spec/).
+
+### Identify
+
+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:
+
+```js
+analytics.identify('userId123', {
+  name: 'John Doe',
+  email: '[email protected]',
+  phone: '012346789',
+  avatar: 'https://pbs.twimg.com/profile_images/834424630630817795/TfyS4uXb_400x400.jpg'
+});
+```
+
+### Track
+
+Crisp adds [Track](/docs/connections/spec/track/) events to the User's profile events stream.
+
+```js
+analytics.track('Completed Purchase', {
+  revenue: 42.99,
+  shippingMethod: '2-day',
+  category: 'Conversion'
+});
+```
+> warning ""
+> 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.
+
+