Technical description
Fields and mapping for Tixly
What we retrieve from Tixly, how often, and what the fields are called in Heyloyalty. This page is for your developer or integration partner. If you just want to know what the integration can do, the other page is the better one.
How it runs
Once it is set up, the integration retrieves data from Tixly every five minutes and checks both members and orders. It draws on Tixly endpoints for customers, events and sales, plus the product feed. A manual import is started from the three dots on the integration overview and covers at most one year at a time.
What you need
An access token and a feed key from Tixly support, a Premium licence or higher, an active list, and a tracking integration on that list. In Heyloyalty you pick the list and the match field: email or mobile number.
Two-way, if you want it
Two-way for member data is switched on from the integration page. Edits, deletions and anonymisation then travel back to Tixly. Permissions travel back either way. See below.
Marketing permission
Permissions are retrieved from Tixly and created as a multi-select field on the list. Leave the field blank in the integration setup. It fills itself in once there is data on the member. Historical permissions do not come across automatically and need a manual import.
If a member arrives from Tixly without a permission, the consent has to come from somewhere else, for example a sign-up form or a pop-up. There are three ways to handle it:
- 1 The member is updated on the list so the permission shows, and it is handled from there with a segment. The simplest, and the one we recommend.
- 2 The member is updated, and a member action moves them to the newsletter list.
- 3 The member is updated, and a member action creates a copy on the newsletter list.
Whichever you pick, behavioural data can be used across lists.
When someone unsubscribes
If you unsubscribe a member in Heyloyalty without two-way enabled, their permission is removed in Tixly, but the member stays. With two-way enabled the same happens when you delete, unsubscribe or anonymise: the permissions go, and the member can still be found in Tixly without them.
Field mapping
69 fields across four sources. The Tixly name on the left, the Heyloyalty name on the right. Fields not listed here are not retrieved in the standard setup. They can be mapped in the integration settings, but then they only apply to data arriving after that.
The guest
From Tixly's Customers endpoint. These are the fields that land on the member in Heyloyalty, and the ones you segment on.
| Tixly | Heyloyalty | Note |
|---|---|---|
| Id | Tixly-id | Locked field |
| FirstName | Firstname | |
| LastName | Lastname | |
| Either this or Mobile is required | ||
| Mobile | mobile | Either this or Email is required |
| Gender | Sex | A number from Tixly: 0 = none, 1 = male, 2 = female |
| DateOfBirth | birthday | The date only, the timestamp is stripped |
| AddressOne | address | |
| ZipCode | Zip_code | |
| City | City | |
| CompanyName | Firmanavn | Custom field |
| Tags | Tixly-tags | Multi-select field on the list. Only ever read from Tixly, never written back |
| permissions.name | Tixly Permission Type | Multi-select field. Created on the member when there is data. Leave it blank in the integration setup |
-
Id → Tixly-id
Locked field
-
FirstName → Firstname
-
LastName → Lastname
-
Email → Email
Either this or Mobile is required
-
Mobile → mobile
Either this or Email is required
-
Gender → Sex
A number from Tixly: 0 = none, 1 = male, 2 = female
-
DateOfBirth → birthday
The date only, the timestamp is stripped
-
AddressOne → address
-
ZipCode → Zip_code
-
City → City
-
CompanyName → Firmanavn
Custom field
-
Tags → Tixly-tags
Multi-select field on the list. Only ever read from Tixly, never written back
-
permissions.name → Tixly Permission Type
Multi-select field. Created on the member when there is data. Leave it blank in the integration setup
The performance
From the Event endpoint. It enriches the line items on a purchase, so you can segment on what the guest saw, not just on the fact that they bought something.
| Tixly | Heyloyalty | Note |
|---|---|---|
| Id | productid | Always enriched from the id and cannot be changed |
| Name | Product_name | |
| SubTitle | description | |
| Venue | Venue | |
| Hall | Hall | |
| Season | season | |
| EventGroup | EventGroup | |
| Categories.Name | Category_name | Split according to the import setting |
| Categories.Id | Category_id | Split according to the import setting |
| Tags.Name | Tags_name | The name is what shows in Heyloyalty, not the id |
| Tags.Id | Tags_id | |
| StartDate | StartDate | |
| EndDate | EndDate | |
| Promoter | Promoter | |
| Sold | Sold | Number |
| Capacity | Capacity | Number |
| AvailableOnline | AvailableOnline | |
| OnlineReservationAllowed | OnlineReservationAllowed | |
| IsFreeEvent | IsFreeEvent | |
| Created | Created |
-
Id → productid
Always enriched from the id and cannot be changed
-
Name → Product_name
-
SubTitle → description
-
Venue → Venue
-
Hall → Hall
-
Season → season
-
EventGroup → EventGroup
-
Categories.Name → Category_name
Split according to the import setting
-
Categories.Id → Category_id
Split according to the import setting
-
Tags.Name → Tags_name
The name is what shows in Heyloyalty, not the id
-
Tags.Id → Tags_id
-
StartDate → StartDate
-
EndDate → EndDate
-
Promoter → Promoter
-
Sold → Sold
Number
-
Capacity → Capacity
Number
-
AvailableOnline → AvailableOnline
-
OnlineReservationAllowed → OnlineReservationAllowed
-
IsFreeEvent → IsFreeEvent
-
Created → Created
The purchase
From the Events/sales endpoint. This is the individual ticket: what it cost, where the seat was, and whether it was scanned at the door.
| Tixly | Heyloyalty | Note |
|---|---|---|
| OrderId | Order_number | |
| SaleTicketId | SaleTicketId | |
| EventId | Product_id | |
| CustomerId | Tixly_CustomerId | Used to find the member and enrich the email field |
| TicketType | TicketType | |
| TicketCount | TicketCount | |
| Price | Product_price | |
| Fee | Fee | |
| PriceZone | PriceZone | |
| Section | Section | |
| Row | Row | |
| Seat | Seat | |
| Entrance | Entrance | |
| Online | BoughtOnline | Yes/no: bought online or at the box office |
| Scanned | Scanned | Yes/no: whether the ticket was scanned |
| ScannedDate | ScannedTime | |
| Created | Created_at | |
| OrderUrl | url | |
| SubscriptionTypeId | Sub_Id | Coming soon. Will be enriched from the subscriptions endpoint once Tixly opens it |
-
OrderId → Order_number
-
SaleTicketId → SaleTicketId
-
EventId → Product_id
-
CustomerId → Tixly_CustomerId
Used to find the member and enrich the email field
-
TicketType → TicketType
-
TicketCount → TicketCount
-
Price → Product_price
-
Fee → Fee
-
PriceZone → PriceZone
-
Section → Section
-
Row → Row
-
Seat → Seat
-
Entrance → Entrance
-
Online → BoughtOnline
Yes/no: bought online or at the box office
-
Scanned → Scanned
Yes/no: whether the ticket was scanned
-
ScannedDate → ScannedTime
-
Created → Created_at
-
OrderUrl → url
-
SubscriptionTypeId → Sub_Id
Coming soon. Will be enriched from the subscriptions endpoint once Tixly opens it
The product feed
The feed is what draws the performances in the newsletter: image, price and link. It is set up with a feed key from Tixly.
| Tixly | Heyloyalty | Note |
|---|---|---|
| EventGroupId | ProductId | |
| Name | Productnavn | |
| Description | Beskrivelse | |
| SubTitle | SubTitle | |
| Organisation | Organisation | |
| EventImagePath | Image_url | |
| PurchaseUrls[0].Link | url | |
| Categories | Kategorinavn | |
| Season | Season | |
| Duration | Duration | |
| StartDate | StartDate | |
| EndDate | EndDate | |
| OnlineSaleStart | OnlineSaleStart | |
| OnlineSaleEnd | OnlineSaleEnd | |
| SoldOut | SoldOut | Yes/no |
| MinPrice | Udsalgspris | |
| MaxPrice | OriginalPrice |
-
EventGroupId → ProductId
-
Name → Productnavn
-
Description → Beskrivelse
-
SubTitle → SubTitle
-
Organisation → Organisation
-
EventImagePath → Image_url
-
PurchaseUrls[0].Link → url
-
Categories → Kategorinavn
-
Season → Season
-
Duration → Duration
-
StartDate → StartDate
-
EndDate → EndDate
-
OnlineSaleStart → OnlineSaleStart
-
OnlineSaleEnd → OnlineSaleEnd
-
SoldOut → SoldOut
Yes/no
-
MinPrice → Udsalgspris
-
MaxPrice → OriginalPrice
What the integration cannot do today
- Subscriptions. The Tixly endpoint for a customer’s subscriptions is not open yet, so season passes and subscription types do not come across.
- Scan data requires Tixly to make it available to you. The fields are there, but the data only arrives if you scan.
- Fields the Tixly API does not have cannot be mapped. If Tixly changes their API, the mapping has to be updated and the data imported again.
- Anonymising a member in Heyloyalty does not anonymise them in Tixly. That only works the other way round, so anonymise in Tixly.