Merge pull request #1937 from segmentio/perkville_docs

New Destination Partner - Perkville docs

Author: markzegarelli

src/_data/catalog/destinations.yml

@@ -17285,6 +17285,92 @@ items:
       characters long, and look something like this: `43c4b9f66d5f88435700003c`.
     required: true
     label: Advertiser ID
+- display_name: Perkville
+  name: Perkville
+  slug: perkville
+  hidden: false
+  url: connections/destinations/catalog/perkville
+  previous_names:
+  - Perkville
+  website: https://www.perkville.com/
+  status: PUBLIC_BETA
+  categories:
+  - Referrals
+  logo:
+    url: >-
+      https://public-segment-devcenter-production.s3.amazonaws.com/493a250b-60e1-4c61-8619-25059cfedc9e.svg
+  mark:
+    url: >-
+      https://public-segment-devcenter-production.s3.amazonaws.com/58ca6823-e03a-4f91-92cc-dc289f1eaccb.svg
+  methods:
+    track: true
+    identify: false
+    group: false
+    alias: false
+    page: false
+  platforms:
+    browser: true
+    mobile: true
+    server: true
+  components: []
+  browserUnbundlingSupported: false
+  browserUnbundlingPublic: false
+  replay: false
+  connection_modes:
+    device:
+      web: false
+      mobile: false
+      server: false
+    cloud:
+      web: false
+      mobile: false
+      server: false
+    summary: No connection mode information available.
+    cmode_type: none
+    case: '0'
+  settings:
+  - name: apiKey
+    type: string
+    defaultValue: ''
+    description: >-
+      Generate the token in Settings > Apps. Click "show token" under the
+      Segment app, then copy it and paste the value here.
+    required: true
+    label: API Key
+  - name: businessId
+    type: string
+    defaultValue: ''
+    description: >-
+      Your Perkville business ID. Reach out to [email protected] for this
+      information.
+    required: true
+    label: Business ID
+  - name: eventToPerkMap
+    type: text-map
+    defaultValue: {}
+    description: >-
+      Map your event names to the perk you would like to award points for. For
+      instance, "Checked In" > 123456. This will award all "Checked In" events
+      with perk 123456.
+    required: true
+    label: Event to Perk Map
+  - name: locationId
+    type: string
+    defaultValue: ''
+    description: >-
+      Your Perkville Location ID. Reach out to [email protected] for this
+      information.
+    required: true
+    label: Location ID
+  - name: sendEmail
+    type: boolean
+    defaultValue: false
+    description: >-
+      If we post a transaction, send a transactional email to the email address
+      provided in the event. Set to False if you want to suppress emails for
+      this flow.
+    required: true
+    label: Send email
 - display_name: PersistIQ
   name: PersistIQ
   slug: persistiq

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

@@ -0,0 +1,54 @@
+---
+title: Perkville Destination
+rewrite: true
+---
+
+[Perkville](https://www.perkville.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a customer reward and referral platform - similar to airline mile programs - that integrates with e-commerce, point of sale, membership and scheduling systems to provide a seamless experience that drives referrals and loyalty.
+
+This destination is maintained by Perkville. For any issues with the destination, [contact the Perkville Support team](mailto:[email protected]).
+
+The Perkville Destination is in beta, which means that they are still actively developing the destination. To join their beta program, or if you have any feedback to help improve the Perkville Destination and its documentation, [contact the Perkville support team](mailto:[email protected]).
+
+
+## Getting Started
+
+{% include content/connection-modes.md %}
+
+1. From the Destinations catalog page in the Segment App, click **Add Destination**.
+2. Search for "Perkville" in the Destinations Catalog, and select the "Perkville" destination.
+3. Choose which Source should send data to the "Perkville" destination.
+4. Go to [Perkville > Settings > Apps](https://www.perkville.com/settings/usr/apps/){:target="_blank"} while logged in as an admin.
+5. Under Connect Segment, click "Generate Token" and then "Accept."
+6. Click "Show token" under the Segment app, then copy the token.
+7. Paste the token into the "API Key" field for the "Perkville" destination settings in Segment.
+
+
+## Supported methods
+
+Perkville supports the following method, as specified in the [Segment Spec](/docs/connections/spec).
+
+
+### Track
+
+Send [Track](/docs/connections/spec/track) calls to award points for allowlisted actions. For example:
+
+```js
+analytics.track('Order Completed', {
+  order_id: 'o283h08fh2390f923uofu23',
+  revenue: 9.99,
+  email: '[email protected]'
+});
+```
+
+> warning "Important"
+> You should only send the track events you need to Perkville. You may use [Segment Destination Filters](/docs/connections/destinations/destination-filters/) to prevent unwanted events being sent to Perkville. You must allowlist the names of the events you need in the Perkville destination settings in the Segment App. Segment sends those events to Perkville for you, and returns an error if the event is not allowlisted.
+
+#### Required Values
+
+The only required event value is `email`. This must be present within the `event`, `event.properties`, or `event.context.traits` objects.
+
+#### Quantity Calculation
+
+Any events that have an `order_id` will be treated as spend transactions. The quantity of points given will reflect the event's `revenue`, `value`, or `total` in that priority order. Per [the eCommerce spec](/docs/connections/spec/ecommerce/v2/#order-refunded), if the order event name includes "Refund," points will be removed from the Perkville account associated with the provided email.
+
+All other events default to a quantity of 1.