Merge pull request #1425 from segmentio/impact-partnership-cloud

Impact Partnership Cloud Documentation

Author: pauljaeinyoo

src/_data/catalog/destination_categories.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
-# destination categories last updated 2021-02-22 
+# destination categories last updated 2021-02-23 
 items:
 - display_name: Email Marketing
   slug: email-marketing

src/_data/catalog/destinations.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
-# destination data last updated 2021-02-22 
+# destination data last updated 2021-02-23 
 items:
 - display_name: ActiveCampaign
   slug: activecampaign
@@ -10974,6 +10974,172 @@ items:
   previous_names:
   - IbmUbx
   - IBM UBX
+- display_name: Impact Partnership Cloud
+  slug: impact-partnership-cloud
+  name: catalog/destinations/impact-partnership-cloud
+  description: >-
+    Impact integrates with Segment through a robust and scalable API connection.
+    Once connected, seamlessly track and credit your partners for any Segment
+    event within Impact.
+  hidden: false
+  url: connections/destinations/catalog/impact-partnership-cloud
+  status: PUBLIC_BETA
+  logo:
+    url: >-
+      https://public-segment-devcenter-production.s3.amazonaws.com/318e9621-263d-45a2-80da-2df0a7c78fcd.svg
+  mark:
+    url: >-
+      https://public-segment-devcenter-production.s3.amazonaws.com/edaa6886-d1fe-4af5-a76b-e2832fea8884.svg
+  categories: []
+  components: []
+  platforms:
+    browser: true
+    server: true
+    mobile: true
+  browserUnbundlingSupported: false
+  browserUnbundlingPublic: false
+  methods:
+    alias: false
+    group: false
+    identify: true
+    page_view: true
+    track: true
+  settings:
+  - name: apiKey
+    display_name: API Key
+    type: STRING
+    deprecated: false
+    required: true
+    string_validators:
+      regexp: '^.{8,}$'
+    description: The Auth Token from Impact Settings API page
+    settings: []
+  - name: accountSid
+    display_name: Account SID
+    type: STRING
+    deprecated: false
+    required: true
+    string_validators:
+      regexp: ''
+    description: The Account SID from the Impact Settings API page
+    settings: []
+  - name: actionEventNames
+    display_name: Action Event Names
+    type: LIST
+    deprecated: false
+    required: false
+    description: >-
+      Optional. A list of Segment track events that correspond to a user
+      registration, completed order or other payable event. If multiple events
+      need to be tracked as actions in Impact, please add all events to the
+      array (e.g. Order Completed, User Registered, etc.). This helps us send
+      your events to the correct Impact endpoint. Default: “Order Completed”
+    settings: []
+  - name: androidAppId
+    display_name: Android App ID
+    type: STRING
+    deprecated: false
+    required: false
+    string_validators:
+      regexp: ''
+    description: Required for app tracking. Android app identifier from Impact account.
+    settings: []
+  - name: campaignId
+    display_name: Campaign ID
+    type: STRING
+    deprecated: false
+    required: true
+    string_validators:
+      regexp: ''
+    description: Campaign identifier from Impact account
+    settings: []
+  - name: customParameterMapping
+    display_name: Custom Parameter Mapping
+    type: MAP
+    deprecated: false
+    required: false
+    description: >-
+      Optional. Mapping for any non-default parameters as specified by your
+      Impact representative. The first parameter is the Impact API parameter
+      (e.g. CustomerStatus) and the second is the Segment parameter using dot
+      notation for nested parameters (e.g. properties.customer_status).
+    settings: []
+  - name: enableIdentifyEvents
+    display_name: Enable Identify Events
+    type: BOOLEAN
+    deprecated: false
+    required: false
+    description: Enables identify events to be tracked within Impact.
+    settings: []
+  - name: enablePageEvents
+    display_name: Enable Page Events
+    type: BOOLEAN
+    deprecated: false
+    required: false
+    description: >-
+      Required for web tracking. Enables page events to be tracked within
+      Impact.
+    settings: []
+  - name: enableScreenEvents
+    display_name: Enable Screen Events
+    type: BOOLEAN
+    deprecated: false
+    required: false
+    description: Optional. Enables screen events to be tracked within Impact.
+    settings: []
+  - name: eventTypeId
+    display_name: Event Type ID
+    type: STRING
+    deprecated: false
+    required: false
+    string_validators:
+      regexp: ''
+    description: >-
+      Optional. The ID of the Event Type specified in your Impact Settings. If
+      left blank, we will use the event from Segment to map to Impact's event
+      types. Please confirm the correct mapping is in place with your Impact
+      representative.
+    settings: []
+  - name: installEventNames
+    display_name: Install Event Names
+    type: LIST
+    deprecated: false
+    required: false
+    description: >-
+      Optional. The Segment track event names that correspond to the app install
+      event. Default: "Application Installed"
+    settings: []
+  - name: pageLoadEventNames
+    display_name: Page Load Event Names
+    type: LIST
+    deprecated: false
+    required: false
+    description: >-
+      Optional. A list of Segment track events that correspond to an app open or
+      page load. Default: “Application Opened”. Note events from page, screen or
+      identify are enabled separately with the toggles below and are
+      automatically considered page load events in Impact’s platform.
+    settings: []
+  - name: iOsAppId
+    display_name: iOS App ID
+    type: STRING
+    deprecated: false
+    required: false
+    string_validators:
+      regexp: ''
+    description: Required for app tracking. iOS app identifier from Impact account
+    settings: []
+  connection_modes:
+    device:
+      web: false
+      mobile: false
+      server: false
+    cloud:
+      web: false
+      mobile: false
+      server: false
+  previous_names:
+  - Impact Partnership Cloud
 - display_name: Improvely
   slug: improvely
   name: catalog/destinations/improvely
@@ -13499,13 +13665,6 @@ items:
       required: false
       description: Map your Segment properties to the Marketo Activity Fields
       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
@@ -13541,6 +13700,13 @@ items:
           - 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

src/_data/catalog/source_categories.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
-# source cateogries last updated 2021-02-22 
+# source cateogries last updated 2021-02-23 
 items:
 - display_name: Server
   slug: server

src/_data/catalog/sources.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
-# sources last updated 2021-02-22 
+# sources last updated 2021-02-23 
 items:
 - display_name: .NET
   slug: net

src/connections/destinations/catalog/impact-partnership-cloud/index.md

@@ -0,0 +1,102 @@
+---
+title: Impact Partnership Cloud Destination
+rewrite: true
+---
+
+[Impact Partnership Cloud](https://impact.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) lets you expand your program and scale every type of partnership by managing the partnership lifecycle - from discovery, contracting and payments through tracking and optimization.
+
+This destination is maintained by Impact. For any issues with the destination, contact the [Impact Partnership Cloud team](https://app.impact.com/) or check out [Impact Partnership Cloud's documentation](https://app.impact.com/secure/agency/support/customer-support-portal-flow.ihtml?execution=e3s1).
+
+## Getting Started
+
+{% include content/connection-modes.md %}
+
+1. From the Destinations catalog page in the Segment App, click **Add Destination**.
+2. Search for "Impact Partnership Cloud" in the Destinations Catalog, and select the Impact Partnership Cloud destination.
+3. Choose which Source should send data to the Impact Partnership Cloud destination.
+4. Go to the [Impact Partnership Cloud Settings](https://app.impact.com), find and copy the "Account SID", "Auth Token", and "Campaign ID".
+5. Back in the Impact Partnership Cloud destination settings in Segment, enter the "Account SID", "Auth Token", and "Campaign ID".
+
+## Page
+
+If you aren’t familiar with the Segment Spec, take a look at the [Page method documentation](https://segment.com/docs/connections/spec/page/) to learn about what it does. An example call would look like:
+
+```js
+analytics.page("Home")
+```
+
+Segment sends Page calls to Impact Partnership Cloud as a `Clicks` event, if they fit the definition of a unique click, or as a `Page Load` event.
+
+> success ""
+> **Tip!** To accurately track and attribute actions, send a Page call with every page load.
+
+Read [Impact Partnership Cloud's documentation](https://impact-helpdesk.freshdesk.com/en/support/solutions/articles/48001173251) to learn more about how Page properties are mapped.
+
+## Screen
+
+If you aren’t familiar with the Segment Spec, take a look at the [Screen method documentation](https://segment.com/docs/connections/spec/screen/) to learn about what it does. An example call would look like:
+
+```objc
+[[SEGAnalytics sharedAnalytics] screen:@"Home"];
+```
+Segment sends Screen calls to Impact Partnership Cloud as a `Clicks` event if they fit the definition of a unique click, or as a `Page Load` event.
+
+
+## Identify
+
+If you aren’t familiar with the Segment Spec, take a look at the [Identify method documentation](https://segment.com/docs/connections/spec/identify/) to learn more about what it does. An example call would look like:
+
+```js
+analytics.identify('userId123', {
+  email: '[email protected]'
+});
+```
+Segment sends Identify calls to Impact Partnership Cloud as a `Page Load` event which allows you to update user identifiers.
+
+## Track
+
+If you aren’t familiar with the Segment Spec, take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn more about what it does. An example call would look like:
+
+```js
+analytics.track('Order Completed', {
+  checkout_id: 'fksdjfsdjfisjf9sdfjsd9f',
+  order_id: '50314b8e9bcf000000000000',
+  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',
+      url: 'https://www.example.com/product/path',
+      image_url: 'https:///www.example.com/product/path.jpg'
+    },
+    {
+      product_id: '505bd76785ebb509fc183733',
+      sku: '46493-32',
+      name: 'Uno Card Game',
+      price: 3,
+      quantity: 2,
+      category: 'Games'
+    }
+  ]
+});
+```
+
+Segment sends Track calls to Impact Partnership Cloud as a `Conversion` or `Page Load` event.
+
+`Conversion` events appear as `Actions` on Impact Partnership Cloud's Dashboard.
+
+`Page Load` events appear as `Clicks` on Impact Partnership Cloud's Dashboard if they fit the definition of a unique click.
+
+Read [Impact Partnership Cloud's documentation](https://impact-helpdesk.freshdesk.com/en/support/solutions/articles/48001173251) to learn more about how Track properties are mapped.