Email Service Integration¶
Target Audience: Developers, Stakeholders
Introduction¶
By default Payway (PW) will send an e-mail to end users when certain events occur, such as when a new account is registered. The e-mails sent this way will by default use an e-mail template which is defined in PW and offers very little in the way of being customizable. It is possible to integrate PW with an E-mail Service Provider (ESP) as an alternative to the default, opening up the possibility to tailor fit transactional e-mails and automate marketing.
When an event occurs in PW that will trigger an e-mail action, the event will be propagated to the Payway E-mail Service (PES) which in turn will communicate with the ESP. Currently supported integrations can be viewed here.
Abbreviations¶
| Abbreviation | Full name | Description |
|---|---|---|
| PW | Payway | |
| ESP | E-mail Service Provider | A third party providing e-mail services |
| PES | Payway E-mail Service | Payway software dealing with e-mail integration |
Supported E-mail Service Providers¶
E-mail Events¶
There are currently 40 events in PW that triggers an e-mail being sent to the end user. This section describes each event, when it is triggered and what data it contains.
AccountActivatedForExistingCustomer¶
When an account is activated for an existing customer, this event occurs.
AccountActivatedForExistingCustomer example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"event_type": "AccountActivatedForExistingCustomer",
"organisation_id": "adeprimo"
}
AccountCreatedWithPasswordReset¶
When a new account is registered with an immediate password reset, meaning the customer did not have to enter a password during the registration process, this event occurs.
NewAccountRegistered example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"password_change": {
"portal_login_url": "https://adeprimose.payway-portal.dev.adeprimo.se/Login",
"reset_url": "https://adeprimose.payway-portal.dev.adeprimo.se/Login/RequestPasswordReset",
"return_url": null,
"confirmation_code": null,
"title_code": null
},
"event_type": "AccountCreatedWithPasswordReset",
"organisation_id": "adeprimo"
}
AccountPasswordResetComplete¶
When a password reset is complete, this event occurs.
AccountPasswordResetComplete example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"password_change": {
"portal_login_url": "https://adeprimose.payway-portal.dev.adeprimo.se/Login",
"reset_url": "https://adeprimose.payway-portal.dev.adeprimo.se/Login/RequestPasswordReset",
"return_url": null,
"confirmation_code": null,
"title_code": null
},
"event_type": "AccountPasswordResetComplete",
"organisation_id": "adeprimo"
}
AccountRequestedEmailChange¶
When an account requests an email change, this event occurs.
AccountRequestedEmailChange example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"contact_email_for_update": "new_email@example.com",
"contact_email_update_code": "12345678-1111-2222-3333-123456789012",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"event_additional_data": {
"email_change_url": "https://adeprimo.com/emailChange"
},
"event_type": "AccountRequestedEmailChange",
"organisation_id": "adeprimo"
}
AccountRequestedPasswordReset¶
When an account requests for a new password, this event occurs.
AccountRequestedPasswordReset example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"confirmation_code": "123-456-789",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"event_additional_data": {
"reset_url": "https://adeprimo.com/reset_url",
"return_url": "https://adeprimo.com/return_url"
},
"event_type": "AccountRequestedPasswordReset",
"organisation_id": "adeprimo"
}
ConfirmationEmailRequested¶
When an account confirmation email is requested, this event occurs.
ConfirmationEmailRequested example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"confirmation_code": "123-456-789",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"event_type": "ConfirmationEmailRequested",
"organisation_id": "adeprimo"
}
GiftCreated¶
When a gift is created, this event occurs.
GiftCreated example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"gift": {
"gift_code": "12345-1234-1234-1234-123456789",
"receiver_first_name": "Johan",
"receiver_last_name": "Johansson",
"receiver_contact_email": "johan.johansson@example.com",
"gift_url": "https://adeprimo.portal.worldoftulo.com/v2/shop/adeprimo_plus?giftcode=12345-1234-1234-1234-123456789"
},
"product": {
"product_code": "ade_plus_11",
"name": "Adeprimo plus 11 månader",
"valid_from": "2017-12-07T08:20:47.977+01:00",
"valid_to": "2019-12-07T08:20:47.977+01:00"
},
"event_type": "GiftCreated",
"organisation_id": "adeprimo"
}
GiftOrderClosed¶
When a gift order closedis completed, this event occurs.
GiftOrderClosed example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"order": {
"order_id": "ADEPRIMO-1",
"parent_order": "",
"payment_option": "creditcard",
"purchase_type": "limited",
"created": "2018-10-30T15:08:44+00:00",
"traffic_source": "some_traffic_source",
"subscription_start_date": "0001-01-01T00:00:00",
"delivery_address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
},
"details": {
"description": "(K) Adeprimo Kombo (12 månader)",
"product_code": "adeprimo_campaign_combo",
"price": "49.0",
"vat_code": "12",
"type": "month",
"length": "12"
},
"campaign_package_or_package_product_code": "adeprimo_package"
},
"event_type": "GiftOrderClosed",
"organisation_id": "adeprimo"
}
MarketingPermissionAdded¶
When a marketing permission is accepted by a customer in Payway, this event occurs.
MarketingPermissionAdded example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"marketing_permission": {
"name": "Digital newspaper",
"integration_code": "digital_newspaper"
},
"event_type": "MarketingPermissionAdded",
"organisation_id": "adeprimo"
}
MarketingPermissionRemoved¶
When a marketing permission is rejected by a customer in Payway, this event occurs.
MarketingPermissionRemoved example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"marketing_permission": {
"name": "Digital newspaper",
"integration_code": "digital_newspaper"
},
"event_type": "MarketingPermissionRemoved",
"organisation_id": "adeprimo"
}
NewAccountCreatedFromKis¶
When a new account is created from Klarna Instant Shopping.
NewAccountCreatedFromKis example data
{
"account": {
"id": "5c7cf88295cfeb27b55f6ae1",
"contact_email": "anders@example.com",
"customer_number": "1234567",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "0701231234",
"ssn": "500101-7648",
"birth_date": "1950-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "AB",
"created": "2019-03-04T10:05:54+00:00",
"address": {
"first_name": "Test",
"last_name": "Testsson",
"street": "Andersgatan",
"street_number": "1",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersby",
"mobile_number": null,
"phone_number": "",
"contact_email": null,
"country_code": "SE"
}
},
"password_change": {
"portal_login_url": "https://www.adeprimo.se/login_url",
"reset_url": "https://www.adeprimo.se/reset_url?account_id=5c7cf88295cfeb27b55f6ae1&confirmation_code=73d376f7-c61b-466f-a256-f32706d08851",
"return_url": null,
"confirmation_code": "73d376f7-c61b-466f-a256-f32706d08851"
},
"event_type": "NewAccountCreatedFromKis",
"organisation_id": "adeprimo"
}
NewAccountRegistered¶
When a new account is registered, this event occurs.
NewAccountRegistered example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"event_type": "NewAccountRegistered",
"organisation_id": "adeprimo"
}
NewCheckoutAccountRegistered¶
When a new account is registered via checkout, this event occurs.
NewCheckoutAccountRegistered example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"event_type": "NewCheckoutAccountRegistered",
"organisation_id": "adeprimo"
}
OrderClosed¶
When a purchase in PW is completed this event occurs.
OrderClosed example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"order": {
"order_id": "ADEPRIMO-1",
"parent_order": "",
"payment_option": "creditcard",
"purchase_type": "limited",
"created": "2018-10-30T15:08:44+00:00",
"traffic_source": "some_traffic_source",
"subscription_start_date": "0001-01-01T00:00:00",
"delivery_address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
},
"details": {
"description": "(K) Adeprimo Kombo (12 månader)",
"product_code": "adeprimo_campaign_combo",
"price": "49.0",
"vat_code": "12",
"type": "month",
"length": "12"
},
"campaign_package_or_package_product_code": "adeprimo_package"
},
"event_type": "OrderClosed",
"organisation_id": "adeprimo"
}
OrderClosedShareable¶
When a purchase with an applicable sharing configuration in PW is completed this event occurs.
OrderClosedShareable example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"order": {
"order_id": "ADEPRIMO-1",
"parent_order": "",
"payment_option": "creditcard",
"purchase_type": "limited",
"created": "2018-10-30T15:08:44+00:00",
"traffic_source": "some_traffic_source",
"subscription_start_date": "0001-01-01T00:00:00",
"delivery_address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
},
"details": {
"description": "(K) Adeprimo Kombo (12 månader)",
"product_code": "adeprimo_campaign_combo",
"price": "49.0",
"vat_code": "12",
"type": "month",
"length": "12"
},
"campaign_package_or_package_product_code": "adeprimo_package"
},
"sharing_configuration": {
"name": "My sharing configuration",
"limit": 10,
"sharers_title": "Share your subscription today!",
"sharers_text": "You can now share your subscription to 10 friends and/or members of family."
},
"event_type": "OrderClosedShareable",
"organisation_id": "adeprimo"
}
PackageChangeCompleted¶
When a package change is processed and completed (not to be confused with when a package change is requested), this event occurs.
PackageChangeCompleted example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"new_order": {
"order_id": "ADEPRIMO-1",
"parent_order": "",
"payment_option": "creditcard",
"purchase_type": "limited",
"created": "2018-10-30T15:08:44+00:00",
"traffic_source": "some_traffic_source",
"subscription_start_date": "0001-01-01T00:00:00",
"delivery_address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
},
"details": {
"description": "(K) Adeprimo Kombo (12 månader)",
"product_code": "adeprimo_campaign_combo",
"price": "49.0",
"vat_code": "12",
"type": "month",
"length": "12"
},
"campaign_package_or_package_product_code": "adeprimo_package"
},
"event_type": "PackageChangeCompleted",
"organisation_id": "adeprimo"
}
PackageDowngrade¶
When a package downgrade is requested, this event occurs.
PackageDowngrade example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"new_subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"event_type": "PackageDowngrade",
"organisation_id": "adeprimo"
}
PackageSharingActivated¶
When package sharing is activated/accepted, this event occurs.
PackageSharingActivated example data
{
"share": {
"sharer": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"receiver": {
"id": "52a9b320400e06024b000001",
"contact_email": "johan.johansson@example.com",
"customer_number": "123456",
"first_name": "Johan",
"last_name": "Johansson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Johansson",
"last_name": "Johansson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"invite": {
"activation_code": "12345-1234-1234-1234-123456789",
"contact_email": "johan.johansson@example.com"
}
},
"event_type": "PackageSharingActivated",
"organisation_id": "adeprimo"
}
PackageSharingDeactivated¶
When package sharing is deactivated/removed, this event occurs.
PackageSharingDeactivated example data
{
"share": {
"sharer": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"receiver": {
"id": "52a9b320400e06024b000001",
"contact_email": "johan.johansson@example.com",
"customer_number": "123456",
"first_name": "Johan",
"last_name": "Johansson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Johansson",
"last_name": "Johansson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"invite": {
"activation_code": "12345-1234-1234-1234-123456789",
"contact_email": "johan.johansson@example.com"
}
},
"event_type": "PackageSharingDeactivated",
"organisation_id": "adeprimo"
}
PackageSharingInitialized¶
When package sharing is initialized, this event occurs.
If the receiver has an account, receiver is populated with data. If not, only invite will be populated.
PackageSharingInitialized example data
{
"share": {
"sharer": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"receiver": {
"id": "52a9b320400e06024b000001",
"contact_email": "johan.johansson@example.com",
"customer_number": "123456",
"first_name": "Johan",
"last_name": "Johansson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Johansson",
"last_name": "Johansson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"invite": {
"activation_code": "12345-1234-1234-1234-123456789",
"contact_email": "johan.johansson@example.com"
}
},
"event_type": "PackageSharingInitialized",
"organisation_id": "adeprimo"
}
PackageUpgrade¶
When a package upgrade is requested, this event occurs.
PackageUpgrade example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"new_subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"order": {
"order_id": "ADEPRIMO-1",
"parent_order": "",
"payment_option": "creditcard",
"purchase_type": "limited",
"created": "2018-10-30T15:08:44+00:00",
"traffic_source": "some_traffic_source",
"subscription_start_date": "0001-01-01T00:00:00",
"delivery_address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
},
"details": {
"description": "(K) Adeprimo Kombo (12 månader)",
"product_code": "adeprimo_campaign_combo",
"price": "49.0",
"vat_code": "12",
"type": "month",
"length": "12"
},
"campaign_package_or_package_product_code": "adeprimo_package"
},
"event_type": "PackageUpgrade",
"organisation_id": "adeprimo"
}
PaymentAgreementAboutToExpire¶
When a payment agreement (for example, a creditcard) is about to reach it's expiry date, this event occurs.
PaymentAgreementAboutToExpire example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"order": {
"order_id": "ADEPRIMO-1",
"parent_order": "",
"payment_option": "creditcard",
"purchase_type": "limited",
"created": "2018-10-30T15:08:44+00:00",
"traffic_source": "some_traffic_source",
"subscription_start_date": "0001-01-01T00:00:00",
"delivery_address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
},
"details": {
"description": "(K) Adeprimo Kombo (12 månader)",
"product_code": "adeprimo_campaign_combo",
"price": "49.0",
"vat_code": "12",
"type": "month",
"length": "12"
},
"campaign_package_or_package_product_code": "adeprimo_package"
},
"payment_about_to_expire": {
"expire_days": "5",
"expire_date": "2018-12-30T15:08:44+00:00",
"expiration_date": "2018-12-30",
"masked_creditcard": "123456******7890"
},
"event_type": "PaymentAgreementAboutToExpire",
"organisation_id": "adeprimo"
}
PaymentFailure¶
When a payment has failed, this event occurs.
PaymentFailure example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"payment": {
"type": "autopay",
"amount": "100.00",
"vat_amount": "25.00"
},
"event_type": "PaymentFailure",
"organisation_id": "adeprimo"
}
PaymentRetry¶
When a previously failed payment is retried, this event occurs.
PaymentRetry example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"order": {
"order_id": "ADEPRIMO-1",
"parent_order": "",
"payment_option": "creditcard",
"purchase_type": "limited",
"created": "2018-10-30T15:08:44+00:00",
"traffic_source": "some_traffic_source",
"subscription_start_date": "0001-01-01T00:00:00",
"delivery_address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
},
"details": {
"description": "(K) Adeprimo Kombo (12 månader)",
"product_code": "adeprimo_campaign_combo",
"price": "49.0",
"vat_code": "12",
"type": "month",
"length": "12"
},
"campaign_package_or_package_product_code": "adeprimo_package"
},
"payment_retry": {
"original_valid_to": "2018-12-01T15:08:44+00:00",
"next_attempt_date": "2018-12-02T15:08:44+00:00"
"payment_failed_date": "2018-12-01T15:08:44+00:00",
"payment_attempt_days": "5",
"payment_attempt_count": "1"
},
"event_type": "PaymentRetry",
"organisation_id": "adeprimo"
}
PaymentRetrySuccessful¶
When a previously failed payment is retried and succeeds, this event occurs.
PaymentRetrySuccessful example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"order": {
"order_id": "ADEPRIMO-1",
"parent_order": "",
"payment_option": "creditcard",
"purchase_type": "limited",
"created": "2018-10-30T15:08:44+00:00",
"traffic_source": "some_traffic_source",
"subscription_start_date": "0001-01-01T00:00:00",
"delivery_address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
},
"details": {
"description": "(K) Adeprimo Kombo (12 månader)",
"product_code": "adeprimo_campaign_combo",
"price": "49.0",
"vat_code": "12",
"type": "month",
"length": "12"
},
"campaign_package_or_package_product_code": "adeprimo_package"
},
"payment_retry": {
"original_valid_to": "2018-12-01T15:08:44+00:00",
"next_attempt_date": "2018-12-01T15:08:44+00:00",
"payment_failed_date": "2018-12-01T15:08:44+00:00",
"payment_attempt_days": "5",
"payment_attempt_count": "1"
},
"event_type": "PaymentRetrySuccessful",
"organisation_id": "adeprimo"
}
PaymentSuccess¶
When a successful payment is completed, this event occurs.
PaymentSuccess example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"payment": {
"type": "autopay",
"amount": "100.00",
"vat_amount": "25.00"
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"event_type": "PaymentSuccess",
"organisation_id": "adeprimo"
}
PaymentUserAgreementInvalidState¶
When user agreement for payment has gotten an invalid state, this event occurs.
PaymentUserAgreementInvalidState example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"payment_profile": {
"expiration": "19000101",
"masked_creditcard": "123456******7890"
},
"event_type": "PaymentUserAgreementInvalidState",
"organisation_id": "adeprimo"
}
PaymentUserProductDeactivated¶
When a user product has been deactivated, this event occurs.
PaymentUserProductDeactivated example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"event_type": "PaymentUserProductDeactivated",
"organisation_id": "adeprimo"
}
PaymentUserProductFrozen¶
When a user product has been frozen, this event occurs.
PaymentUserProductFrozen example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"event_type": "PaymentUserProductFrozen",
"organisation_id": "adeprimo"
}
PaymentUserProductRenewed¶
When a user product has been renewed, this event occurs.
PaymentUserProductRenewed example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"event_type": "PaymentUserProductRenewed",
"organisation_id": "adeprimo"
}
PendingSubscriptionValidationChange¶
When the subscription of a customer is about to expire due to order validation rules, this event occurs.
PendingSubscriptionValidationChange example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"new_price_string": "10 kr/month",
"event_type": "PendingSubscriptionValidationChange",
"organisation_id": "adeprimo"
}
TransitionedToRetentionCampaign¶
When a customer has accepted the offer of a retention campaign, this event occurs.
TransitionedToRetentionCampaign example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"order": {
"order_id": "ADEPRIMO-1",
"parent_order": "",
"payment_option": "creditcard",
"purchase_type": "limited",
"created": "2018-10-30T15:08:44+00:00",
"traffic_source": "some_traffic_source",
"subscription_start_date": "0001-01-01T00:00:00",
"delivery_address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
},
"details": {
"description": "(K) Adeprimo Kombo (12 månader)",
"product_code": "adeprimo_campaign_combo",
"price": "49.0",
"vat_code": "12",
"type": "month",
"length": "12"
},
"campaign_package_or_package_product_code": "adeprimo_package"
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"new_subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"event_type": "TransitionedToRetentionCampaign",
"organisation_id": "adeprimo"
}
UserProductCancelled¶
When a user product has been cancelled, this event occurs.
UserProductCancelled example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"event_type": "UserProductCancelled",
"organisation_id": "adeprimo"
}
UserProductUncancelled¶
When a user product that has previously been cancelled becomes uncancelled, this event occurs.
UserProductUncancelled example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"event_type": "UserProductUncancelled",
"organisation_id": "adeprimo"
}
VerificationFailure¶
When a credit card verification fails, this event occurs.
VerificationFailure example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"order": {
"order_id": "ADEPRIMO-1",
"parent_order": "",
"payment_option": "creditcard",
"purchase_type": "limited",
"created": "2018-10-30T15:08:44+00:00",
"traffic_source": "some_traffic_source",
"subscription_start_date": "0001-01-01T00:00:00",
"delivery_address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
},
"details": {
"description": "(K) Adeprimo Kombo (12 månader)",
"product_code": "adeprimo_campaign_combo",
"price": "49.0",
"vat_code": "12",
"type": "month",
"length": "12"
},
"campaign_package_or_package_product_code": "adeprimo_package"
},
"payment": {
"type": "verification",
"amount": "0.00",
"vat_amount": "0.00"
},
"event_type": "VerificationFailure",
"organisation_id": "adeprimo"
}
VoucherCreated¶
When a voucher/gift card is created/purchased, this event occurs.
VoucherCreated example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"product": {
"product_code": "ade_plus_11",
"name": "Adeprimo plus 11 månader",
"valid_from": "2017-12-07T08:20:47.977+01:00",
"valid_to": "2019-12-07T08:20:47.977+01:00"
},
"receipt": {
"company_name": null,
"crn": null,
"order_id": "ADEPRIMOSE-1",
"company_email": null,
"phone_number": "04123456",
"address": "Andersgatan 1",
"receipt_text": "",
"sum": "100",
"payment_method": "adyen",
"masked_cc_nr": "123456******7890",
"paid_at": "2017-12-07T08:20:47.977+01:00",
"paid_at_date": "2017-12-07",
"articles": [
{
"name": "",
"type": "",
"amount": "",
"numbers": ""
}
],
"vat_specifications": [
{
"vat_amount": "",
"vat_precentage": "",
"net_amount": "",
"gross_amount": ""
}
]
},
"voucher": {
"id": "52a9b320400e06024b654321",
"created_at": "2017-12-07T08:20:47.977+01:00",
"expires_at": "2018-01-07T08:20:47.977+01:00",
"redeemed_at": null,
"days_of_access": 30,
"voucher_code": "ABC123",
"package_code": "adeprimo_digital",
"provision_service": "tulo",
"voucher_details": {
"id": "59b5b320400e06024b654999",
"redeemed_by": null,
"purchased_by": "52n8b320400e06024b654317",
"order_id": "ADEPRIMO-1"
}
// Voucher details are only included for purchased gift cards
},
"event_type": "VoucherCreated",
"organisation_id": "adeprimo"
}
VoucherRedeemed¶
When a voucher/gift card is redeemed, this event occurs.
VoucherRedeemed example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"product": {
"product_code": "ade_plus_11",
"name": "Adeprimo plus 11 månader",
"valid_from": "2017-12-07T08:20:47.977+01:00",
"valid_to": "2019-12-07T08:20:47.977+01:00"
},
"voucher": {
"id": "52a9b320400e06024b654321",
"created_at": "2017-12-07T08:20:47.977+01:00",
"expires_at": "2018-01-07T08:20:47.977+01:00",
"redeemed_at": null,
"days_of_access": 30,
"voucher_code": "ABC123",
"package_code": "adeprimo_digital",
"provision_service": "tulo",
"voucher_details": {
"id": "59b5b320400e06024b654999",
"redeemed_by": null,
"purchased_by": "52n8b320400e06024b654317",
"order_id": "ADEPRIMO-1"
}
// Voucher details are only included for purchased gift cards
},
"event_type": "VoucherRedeemed",
"organisation_id": "adeprimo"
}
VoucherUserProductDeactivated¶
When a user product that was provisioned via a voucher and/or gift card has been deactivated, this event occurs.
VoucherUserProductDeactivated example data
{
"account": {
"id": "52a9b320400e06024b000001",
"contact_email": "me@example.com",
"customer_number": "123456",
"first_name": "Anders",
"last_name": "Andersson",
"mobile_number": "07012345678",
"ssn": "010101-0101",
"birth_date": "1901-01-01T00:00:00+00:00",
"gender": "M",
"status": "active",
"account_origin": "SOME_ORIGIN",
"created": "2013-12-12T12:59:12+00:00",
"address": {
"first_name": "Anders",
"last_name": "Andersson",
"street": "Andersgatan 1",
"street_number": "",
"staircase": "",
"floor": "",
"apartment_number": "",
"zip_code": "12345",
"city": "Andersborg",
"mobile_number": "07012345678",
"phone_number": "",
"country_code": "se"
}
},
"subscription": {
"product_title_name": "Plus",
"product_title_code": "adeprimo_PLUS",
"code": "plus-12-2018",
"name": "Plus i 12 mån för 100 kr/mån",
"is_recurring": true,
"campaign": true,
"valid_from": "1900-00-00T00:00:00+00:00",
"valid_to": "2099-12-31T00:00:00+00:00"
},
"event_type": "VoucherUserProductDeactivated",
"organisation_id": "adeprimo"
}