Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 1.2

Last Updated:

Lastupdatedate

Livesearch
placeholderSearch the Vibes Developer Wiki
typepage



The daily Wallet Instance extract is used to sync Wallet data between Vibes Mobile Engagement Platform and a Customer Relationship Management (CRM) or Campaign Management system. It will contain all of the Wallet instances that have been registered or unregistered since the last data extract.


Note
Note: If your extracts are not in the following format, it was a custom creation and you should reach out to your customer success Customer Success representative for more information about your extract.

File Name

walletInstance_YYYY-MM-DD.txt

Tab Delimited Files

Extract files will have each column delimited by a tab, as well as each record delimited by a line feed.

Contents of Each File

Each file will contain the Subscription activity for each day. The following scenarios will be represented in the following manner:

If wallet object is registered on  4/5/2017

wallet_instance_uid

instance_event

registered_at

unregistered_at

wallet_object_uid

wallet_provider

platform

company_id

campaign_uid

uuid

current_flag

shared_instance

111b2c1234d1e1234567f123456789abcdefghijk123456

registered

2017-04-05 14:30:00 UTC

 

AB123B23-45CA-56D1-EF7G-HIJK89012BZ

Pass

iOS

A2bc3dFg

z1a2a-123a

123456a1-b001

TRUE

FALSE

 If wallet object is registered and unregistered on 4/5/2017

wallet_instance_uid

instance_event

registered_at

unregistered_at

wallet_object_uid

wallet_provider

platform

company_id

campaign_uid

uuid

current_flag

shared_instance

111b2c1234d1e1234567f123456789abcdefghijk123456

unregistered

2017-04-05 14:30:00 UTC

2017-04-05 15:30:00 UTC

AB123B23-45CA-56D1-EF7G-HIJK89012BZ

Pass

iOS

A2bc3dFg

z1a2a-123a

123456a1-b001

FALSE

FALSE

 If wallet object is registered and unregistered on 4/5/2017 and the same object is registered again on 4/5/2017

wallet_instance_uid

instance_event

registered_at

unregistered_at

wallet_object_uid

wallet_provider

platform

company_id

campaign_uid

uuid

current_flag

shared_instance

111b2c1234d1e1234567f123456789abcdefghijk123456

unregistered

2017-04-05 14:30:00 UTC

2017-04-05 15:30:00 UTC

AB123B23-45CA-56D1-EF7G-HIJK89012BZ

Pass

iOS

A2bc3dFg

z1a2a-123a

123456a1-b001

FALSE

FALSE

111b2c1234d1e1234567f123456789abcdefghijk123456

registered

2017-04-05 16:30:00 UTC

 

AB123B23-45CA-56D1-EF7G-HIJK89012BZ

Pass

iOS

A2bc3dFg

z1a2a-123a

123456a1-b001

TRUE

TRUE

File Body

The file body can contain the following fields as data, separated by the delimiter and a header row.

Field Name
Data Type
Description
wallet_instance_uidString

Unique Vibes-specific Identifier for each Wallet instance that's been installed.

instance_eventStringType of Wallet instance event. Valid values: Registered and Unregistered.
registered_atDate/TimeThe Date/Time when the Wallet object was installed. Format example: "2017-04-05 14:30:00 UTC".
unregistered_atDate/TimeDate/Time when the Wallet object was uninstalled. Format example: "2017-04-05 14:30:00 UTC".
wallet_object_uidString

Unique identifier for the Wallet object of this instance.

wallet_providerStringString name for the installed provider. Valid values are Pass and Wallet.
platformStringString for the specified device platform. Example: 'Android 7.1.1', 'iOS 10.3', and so on.
company_idStringUnique string representing the Vibes Company account.
campaign_uidStringGlobal Unique ID representing the campaign at Vibes.
uuidString

This is a campaign-specific identifier that is used to identify Wallet objects. This is generally customer defined, as it can be included in links and used before a Wallet object is actually created.

Note
Note: uuid = wallet_item_id.


current_flagBooleanIt is True if the instance is currently registered, or False if the instance has been unregistered.
shared_instanceBooleanIt is False if this the first installed instance for the Wallet object, or True otherwise.


Example File

View file
namewalletinstance_sample.txt
height150