Skip to content

Commit e727f1d

Browse files
authored
Merge pull request #4143 from segmentio/thomas/paytronix
Add new paytronix docs
2 parents a9232d3 + dbb4974 commit e727f1d

File tree

1 file changed

+70
-2
lines changed
  • src/connections/sources/catalog/cloud-apps/paytronix

1 file changed

+70
-2
lines changed
Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,72 @@
11
---
22
title: 'Paytronix Source'
3-
hidden: true
4-
---
3+
id: Zd5BXedXsa
4+
beta: true
5+
---
6+
7+
[Paytronix](https://support-paytronix.force.com/help/s/article/000001348){:target="_blank”} is the leading provider of Digital Customer Engagement Solutions for restaurants, convenience stores, and retailers who seek to develop lasting relationships with their guests. For over 20 years, Paytronix has grown its Guest Engagement Platform to seamlessly incorporate individual components of digital customer engagement into a single, robust platform.
8+
9+
This is an [Event Cloud Source](https://segment.com/docs/sources/#event-cloud-sources){:target="_blank”} which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations.
10+
11+
This source is maintained by Paytronix. For any issues with the source, [contact the Paytronix Support team](mailto:[email protected]){:target="_blank”}.
12+
13+
> info ""
14+
> The Paytronix Source is currently in beta, which means that they are still actively developing the source. This doc was last updated on January 27, 2023. If you are interested in joining their beta program or have any feedback to help improve the Paytronix Source and its documentation, [let the Paytronix team know](mailto:[email protected]){:target="blank"}.
15+
16+
## Getting started
17+
18+
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**.
19+
2. Search for "Paytronix" in the Sources Catalog, select Paytronix, and click **Add Source**.
20+
3. On the next screen, give the Source a nickname, and configure any other settings.
21+
- The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but Segment recommends using something that reflects the source itself and distinguishes amongst your environments (for example, Paytronix_Prod, Paytronix_Staging, or Paytronix_Dev).
22+
5. Click **Add Source** to save your settings.
23+
6. Copy the Write key from the Segment UI. Include this WriteKey in your request to Paytronix Support to turn on the Segment Source Integration.
24+
25+
26+
## Events
27+
28+
The table below lists events that Paytronix sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. Paytronix includes the `userId` if available.
29+
30+
| Event Name | Description |
31+
| ----------------- | ------------------------------------------------------- |
32+
| POS Activity | When a guest performs a function at the POS |
33+
| Identify Customer | Loyalty guest is identified |
34+
| Web Registration | Loyalty registration occurred on guest website |
35+
| Referral | Refer A Friend |
36+
| Check-In | When a guest checks-in |
37+
| Recharge Value | Guest adds value to their stored value account |
38+
| Survey Completion | Guest completes survey |
39+
| Loyalty Registration | Guest signs up for loyalty account |
40+
| Add/Redeem | Guest accrues and/or spends points |
41+
42+
## Event properties
43+
44+
The table below list the properties included in the events listed above.
45+
46+
| Property Name | Description |
47+
|------------------------|-----------------------------------------------------|
48+
| first_name | First name of the user |
49+
| last_name | Last name of the user |
50+
| printed_card_number | Loyalty card number |
51+
| email_opt_in | Email Opt-In Status |
52+
| text_opt_in | Text Opt-In Status |
53+
| store_name | Store Name of Purchasing Site |
54+
| store_code | Paytronix Store Code of Purchasing Site |
55+
| store_latitude | Purchasing Site Latitude |
56+
| store_longitude | Purchasing Site Longitude |
57+
| store_city | Purchasing Site City |
58+
| store_postal_code | Purchasing Site Zip Code |
59+
| store_state | Purchasing Site State |
60+
| store_country | Purchasing Site Country |
61+
| wallets_info | Wallet balance |
62+
| all_wallets_info | All available information of wallets |
63+
| flat_wallets_info | Wallet Code, Label, and Balance |
64+
65+
66+
## Adding Destinations
67+
68+
Now that your Source is set up, you can connect it with Destinations.
69+
70+
Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](https://segment.com/docs/connections/event-delivery/){:target="_blank”} tool, and refer to the Destination docs for each tool for troubleshooting.
71+
72+
If there are any issues with how the events are arriving to Segment, [contact the Paytronix support team](mailto:[email protected]){:target="_blank”}.

0 commit comments

Comments
 (0)