Email Service Integration - Tags¶
Target Audience: Developers, Stakeholders
Introduction¶
An event and it's payload in Payway corresponds to so-called tags in most e-mail service integrations. This means that you can construct or even combine tags within your email templates, and by doing so, achieve email's with dynamic content. The content that can be included in an email entirely depends on what objects that are available within the email event.
Examples¶
| Provider | Example Input | Example Output |
|---|---|---|
| Rule | See Rule GUI | See Rule GUI |
| MailChimp | Hello {{PWAccount_FirstName}} {{PWAccount_LastName}} ! | Hello Jane Doe ! |
Tags¶
To get an idea of which tags are possible, we have listed all possible tags below. Note that all tags are not included in all events.
AccountActivatedForExistingCustomer¶
AccountCreatedWithPasswordReset¶
AccountPasswordResetComplete¶
AccountRequestedEmailChange¶
AccountRequestedPasswordReset¶
ConfirmationEmailRequested¶
GiftCreated¶
GiftOrderClosed¶
MarketingPermissionAdded¶
MarketingPermissionRemoved¶
NewAccountCreatedFromKis¶
NewAccountRegistered¶
NewCheckoutAccountRegistered¶
OrderClosed¶
- PWAccount
- PWAccount_Address
- PWOrder
- PWOrder_DeliveryAddress
- PWOrder_OrderDetail
- PWReceipt
- PWSubscription
OrderClosedShareable¶
- PWAccount
- PWAccount_Address
- PWOrder
- PWOrder_DeliveryAddress
- PWOrder_OrderDetail
- PWReceipt
- PWSubscription
- PWSharingConfiguration
PackageChangeCompleted¶
PackageDowngrade¶
PackageSharingActivated¶
PackageSharingDeactivated¶
PackageSharingInitialized¶
PackageUpgrade¶
- PWAccount
- PWAccount_Address
- PWSubscription
- PWNew_Subscription
- PWOrder
- PWOrder_DeliveryAddress
- PWOrder_OrderDetail
PaymentAgreementAboutToExpire¶
PaymentFailure¶
- PWAccount
- PWAccount_Address
- PWOrder
- PWOrder_DeliveryAddress
- PWOrder_OrderDetail
- PWPayment
- PWSubscription
PaymentRetry¶
PaymentRetrySuccessful¶
PaymentSuccess¶
PaymentUserAgreementInvalidState¶
PaymentUserProductDeactivated¶
PaymentUserProductFrozen¶
PaymentUserProductRenewed¶
PendingSubscriptionValidationChange¶
- PWAccount
- PWAccount_Address
- PWSubscription
- PWNewPriceString (String)
PendingUserProductActivated¶
TransitionedToRetentionCampaign¶
- PWAccount
- PWAccount_Address
- PWSubscription
- PWNew_Subscription
- PWOrder - limited
- PWOrder_DeliveryAddress
- PWOrder_OrderDetail
UserProductCancelled¶
UserProductUncancelled¶
VerificationFailure¶
VoucherCreated¶
VoucherRedeemed¶
VoucherUserProductDeactivated¶
Member fields¶
PWAccount¶
PWAccount
Id
Email
CustomerNumber
FirstName
LastName
MobileNumber
SocialSecurityNumber
BirthDate
Gender
Status - "created", "active", "inactive", "archived"
AccountOrigin - Might have been set when the account was created
Created - When the account was created
LatestAccountTitleCode
PWAccount_Address¶
PWAccount_Address
FirstName
LastName
Street
StreetNumber
StairCase
Floor
ApartmentNumber
ZipCode
City
MobileNumber
PhoneNumber
Email
CountryCode
PWEmailChange¶
PWEmailChange
NewEmail
UpdateCode
EmailChangeUrl
CompleteEmailChangeUrl
PWGift¶
PWGift
GiftCode
ReceiverFirstName
ReceiverLastName
ReceiverContactEmail
GiftUrl
PWInvite¶
PWInvite
ActivationCode
ContactEmail
PWMarketingPermission¶
PWMarketingPermission
Name
IntegrationCode
PWOrder¶
PWOrder
Id - Order id
ParentOrder - If transformed from campaign
PaymentOption - "creditcard", "invoice", "autogiro", "sms", "directdebit", "directdebit_recurring", "free", "klarna", "klarna_payments"
Price - Charged price
VatAmount - Charged vat
PurchaseType - "limited", "recurring", "single"
Created - Date and time when the order was created
CreatedDate - Date when the order was created
TrafficSource - If set
SubscriptionStart - If the subscription starts in the future, otherwise 0001-01-01 00:00
SubscriptionStartDate - If the subscription starts in the future, otherwise 0001-01-01
MerchantReference - Merchant reference, more information here
LimitedCampaign
PWOrder_OrderDetail¶
PWOrder_OrderDetail
Length - Period length
Type - "day", "week", "month", "year"
VatCode - Vat percentage
Price - Charged price
BasedOnPackage
Campaign - Campaign or not
ProductCode - Payway product code
Description - Description of the product
PWOrder_BillingAddress¶
PWOrder_BillingAddress
FirstName
LastName
Street
StreetNumber
StairCase
Floor
ApartmentNumber
ZipCode
City
MobileNumber
PhoneNumber
CountryCode
Email
PWOrder_DeliveryAddress¶
PWOrder_DeliveryAddress
FirstName
LastName
Street
StreetNumber
StairCase
Floor
ApartmentNumber
ZipCode
City
MobileNumber
PhoneNumber
CountryCode
Email
PWPackageSharing¶
PWPackageSharing
Created
State
PackageSharingId
PWPasswordChange¶
PWPasswordChange
LoginUrl
ResetUrl
ReturnUrl
ConfirmationCode
TitleCode
PWPayment¶
PWPayment
Type - "normal", "autopay", "credit", "payment_profile_update"
Price
ValueAddedTax
PWPaymentExpire¶
PWPaymentExpire
ExpireDate - E.g. "2020-01-13"
ExpireDateTime - E.g. "2020-01-13 00:00:00"
ExpireDays - Days left until expiration
MaskedCreditcard
PWPaymentProfile¶
PWPaymentProfile
MaskedCreditcard
ExpireDate
PWPaymentRetryData¶
PWPaymentRetryData
PaymentAttemptCount - Number of attempts in total
PaymentAttemptDays - Number of attempted days
PaymentFailedDate - The date of the first failure
NextAttemptDate
OriginalValidTo
PWProduct¶
PWProduct
ProductCode
Name
ValidFrom
ValidFromDate
ValidTo
ValidToDate
Tags
PWReason¶
PWReason
Reason: "payment_failure", "invalid_agreement", "no_profile"
PWReceipt¶
PWReceipt
CompanyName
Crn
OrderId
CompanyEmail
PhoneNumber
Address
ReceiptText
Sum
PaymentMethod
MaskedCreditcardNumber
PaidAt
PaidAtDate
Articles - List of articles, JSON-format
VatSpecifications - List of vat specifications, JSON-format
PWSharingConfiguration¶
PWSharingConfiguration
Name
Limit
SharersTitle
SharersText
PWSubscription¶
PWSubscription
Title
TitleCode
Code
Name
Recurring
Campaign
ValidFrom
ValidFromDate
ValidTo
ValidToDate
State
CancellationReason
Tags
PWVoucher¶
PWVoucher
Id CreatedAt ExpiresAt RedeemedAt DaysOfAccess VoucherCode PackageCode ProvisionService
PWVoucher_Details¶
PWVoucher_Details
Id RedeemedBy PurchasedBy OrderId