New Destination Partner - Perkville docs

Author: charholt

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

@@ -0,0 +1,55 @@
+---
+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 ecommerce, 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 currently 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 whitelisted actions. For example:
+
+```js
+analytics.track('Order Completed', {
+  order_id: 'o283h08fh2390f923uofu23',
+  revenue: 9.99,
+  email: '[email protected]'
+});
+```
+
+**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 unwated events being sent to Perkville. You must whitelist the names of the events you need in your Segment UI settings for Perkville. We will only send those events to Perkville for you, and throw an error if the event is not whitelisted.
+
+#### 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 will default to a quantity of 1.
+
+---