Merge pull request #1803 from segmentio/sailthruv2-docs

Sailthru V2 docs

Author: pauljaeinyoo

src/_data/catalog/destinations.yml

@@ -19067,38 +19067,39 @@ items:
       Install.
     required: true
     label: Tenant Alias
-- display_name: Sailthru
-  name: Sailthru
-  slug: sailthru
+- display_name: Sailthru v2
+  name: Sailthru v2
+  slug: sailthru-v2
   hidden: false
-  url: connections/destinations/catalog/sailthru
+  url: connections/destinations/catalog/sailthru-v2
   previous_names:
-  - Sailthru
-  website: 'http://www.sailthru.com/'
-  status: PUBLIC
+  - Sailthru v2
+  website: 'https://www.sailthru.com/'
+  status: PUBLIC_BETA
   categories:
-  - CRM
   - Email Marketing
+  - Marketing Automation
+  - Personalization
+  - SMS & Push Notifications
   logo:
-    url: 'https://cdn.filepicker.io/api/file/B1tNaheQOymcfo3J2X5b'
+    url: >-
+      https://public-segment-devcenter-production.s3.amazonaws.com/6e3a2032-6567-4f83-ac9a-8ba61da2fe59.svg
   mark:
-    url: 'https://cdn.filepicker.io/api/file/TcAqtDXHQCiCUUdePp6C'
+    url: >-
+      https://public-segment-devcenter-production.s3.amazonaws.com/2eb63829-fe1e-4e47-b921-1fcf0916b5ba.svg
   methods:
     track: true
     identify: true
     group: false
     alias: false
-    page: false
+    page: true
   platforms:
-    browser: false
-    mobile: false
+    browser: true
+    mobile: true
     server: true
-  components:
-  - code: >-
-      https://github.com/segmentio/integrations/tree/master/integrations/sailthru
-    type: server
+  components: []
   browserUnbundlingSupported: false
-  browserUnbundlingPublic: true
+  browserUnbundlingPublic: false
   replay: false
   connection_modes:
     device:
@@ -19107,69 +19108,40 @@ items:
       server: false
     cloud:
       web: false
-      mobile: true
-      server: true
-    summary: >-
-      accepts data from any Segment mobile or server source in cloud mode. It
-      does not accept data from a web source, and does not offer device-mode
-      connections.
-    cmode_type: cloud-only
-    case: '6'
+      mobile: false
+      server: false
+    summary: No connection mode information available.
+    cmode_type: none
+    case: '0'
   settings:
   - name: apiKey
     type: string
     defaultValue: ''
-    description: The API key found in your Sailthru dashboard.
+    description: >-
+      Sailthru API Key. Please talk to your CSM for Segment-specific
+      credentials.
     required: true
     label: API Key
-  - name: customerId
-    type: string
-    defaultValue: ''
-    description: >-
-      **Required  for page calls**. This value can be found in your Sailthru
-      Dashboard under **App Settings**
-    required: false
-    label: Customer Id
-  - name: defaultListName
-    type: string
-    defaultValue: ''
-    description: >-
-      Sailthru best practice dicates every user be added to a list. Configure a
-      default here.
-    required: false
-    label: Default List Name
-  - name: defaultReminderTemplate
-    type: string
-    defaultValue: ''
-    description: >-
-      **Required with Reminder Time**. The **public name** of your template
-      which you first must configure in Sailthru's UI.
-    required: false
-    label: Default Reminder Template
-  - name: defaultReminderTime
+  - name: apiSecret
     type: string
     defaultValue: ''
+    description: Sailthru API Secret
+    required: true
+    label: API Secret
+  - name: trackPageviewsInSailthru
+    type: boolean
+    defaultValue: false
+    description: Generate interest data and enable cart/browse abandonment LO entries.
+    required: true
+    label: Track Pageviews in Sailthru
+  - name: trackScreenEventsAsPageviews
+    type: boolean
+    defaultValue: false
     description: >-
-      **Required with Reminder Template**. The time frame you will want the
-      email to send. **YOU MUST ENTER A NUMERICAL TIME AND FIELD MINUTES, HOURS,
-      WEEKS** For example: `60 minutes`, `24 hours`, `2 weeks`. Segment will
-      handle passing in the `+` increment.
-    required: false
-    label: Default Reminder Time
-  - name: optoutValue
-    type: select
-    defaultValue: none
-    description: >-
-      Select whether to opt out users from email campaigns. The default status
-      is `none`. 
-    required: false
-    label: Optout Status
-  - name: sharedSecret
-    type: password
-    defaultValue: ''
-    description: The Shared Secret found in your Sailthru dashboard.
+      Treat screen events as pageviews within sailthru, you'll need to have a
+      url property to the properties to generate valid pageview events
     required: true
-    label: Shared Secret
+    label: Track Screen events as Pageviews
 - display_name: Salescamp CRM
   name: Salescamp CRM
   slug: salescamp-crm

src/connections/destinations/catalog/sailthru-v2/index.md

@@ -0,0 +1,137 @@
+---
+title: Sailthru V2 New Destination
+rewrite: true
+redirect_from: '/connections/destinations/catalog/sailthru/'
+---
+[Sailthru's](https://yourintegration.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) cross-channel marketing platform helps brands deliver personalized experiences to each and every consumer across email, web, and mobile, driving higher revenue, improving customer lifetime value, and reducing churn.
+
+Sailthru maintains this destination. For any issues with the destination, [contact the Sailthru Support team](mailto:[email protected]).
+
+
+## Getting Started
+
+{% include content/connection-modes.md %}
+
+1. Contact the [Sailthru Support team](mailto:[email protected]) to enable your account for EXTID support and request your integration-specific API Key and Secret.
+2. From the Destinations catalog page in the Segment App, click **Add Destination**.
+3. Search for “Sailthru” in the Destinations Catalog, and select the Sailthru destination.
+4. Choose which Source should send data to the Sailthru destination.
+5. Enter the API Key and Secret in the Sailthru destination settings in Segment.
+
+
+## Supported methods
+
+Sailthru supports the following methods, as specified in the [Segment Spec](/docs/connections/spec)
+
+### Page
+
+Send [Page](/docs/connections/spec/page) calls to Sailthru to add your pageview data to Sailthru and generate interest data, sessions, and trending data.
+
+```js
+analytics.page()
+```
+
+### Screen
+
+Send [Screen](/docs/connections/spec/screen) calls to Sailthru as pageviews by toggling on the `Track Screen events as Pageviews` setting in your Segment destination settings.
+
+```swift
+Analytics.shared().screen("Rick's Tee", properties: [
+    "url": "https://shop.com/products/ricks-tee"
+])
+```
+
+Screen events require a `url` property. If Sailthru receives a Screen call without a `url` property, the call drops.
+
+### Identify
+
+Send [Identify](/docs/connections/spec/identify) calls to to create or update a Sailthru profile for any identified user on your site.
+
+```js
+analytics.identify("assigned-userId", {
+ "name": "Stephen Noel",
+ "email": "[email protected]",
+ "plan": "premium",
+ "logins": 5
+});
+```
+
+### Track
+
+Send [Track](/docs/connections/spec/track) calls to:
+
+* record purchases via “Order Completed” events
+* record abandoned carts via “Product Added” and “Product Removed” events
+* subscribe users via “Subscribed” events
+* trigger Lifecycle Optimizer journeys with all other events
+
+Sailthru automatically creates and maps custom fields from Segment.
+
+#### Subscribe a User
+
+Subscribe a user to a list programmatically with the `Subscribed` event. Sailthru adds Users to the list name passed in the `list` field and resets their opt-out status to Valid for Marketing.
+
+```js
+analytics.track("Subscribed", {
+ "list": "Master List"
+});
+```
+
+#### Record  a Purchase
+
+Record purchases in Sailthru wih the `Order Completed` event to send order confirmation messages, personalize messaging, and create purchase-related audiences.
+
+Each line-item for Sailthru purchases requires the `url` field. Send the `tags` property for each line-item for later segmentation purposes.
+
+Sailthru automatically tracks the `shipping`, `tax`, and `discount` fields as adjustments for accurate purchase values per-user. Use `order_id`, `checkout_id`, or Segment’s `messageId` as a purchase key for later lookup and deduping purposes.
+
+```js
+analytics.track("Order Completed", {
+ "order_id": "smbc-3-18-1",
+ "affiliation": "Google Store",
+ "total": 27.50,
+ "subtotal": 22.50,
+ "revenue": 25.00,
+ "shipping": 3,
+ "tax": 2,
+ "discount": 2.5,
+ "coupon": "hasbros",
+ "currency": "USD",
+ "products": [
+   {
+     "product_id": "507f1f77bcf86cd799439011",
+     "sku": "45790-32",
+     "name": "Monopoly: 3rd Edition",
+     "price": 19,
+     "quantity": 1,
+     "category": "Games",
+     "tags": "games, monopoly, miserable-endings",
+     "url": "https://www.example.com/product/path",
+     "image_url": "https:///www.example.com/product/path.jpg"
+   }
+ ]
+});
+
+```
+
+#### Update Cart
+Send `Product Added` and `Product Removed` Track events for Sailthru’s abandoned cart messaging to enable the Cart Abandonment entry in Lifecycle Optimizer.
+
+Sailthru abandoned cart messaging requires the `url` to function properly. 
+
+```js
+analytics.track('Product Added', {
+  cart_id: 'skdjsidjsdkdj29j',
+  product_id: '507f1f77bcf86cd799439011',
+  url: 'https://example.com/product/path',
+  sku: 'G-32',
+  category: 'Games',
+  name: 'Monopoly: 3rd Edition',
+  brand: 'Hasbro',
+  variant: '200 pieces',
+  price: 18.99,
+  quantity: 1,
+  coupon: 'MAYDEALS',
+  position: 3
+});
+```

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

@@ -1,5 +1,6 @@
 ---
 title: Sailthru Destination
+hidden: true
 ---
 
 ## Getting Started