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

Standard File Name

The following is the recommended best practice for file names. File naming conventions may be changed upon request.

walletinstance_<company_key>_<date>.<extension>

How to Read Files

Extract files will be delivered in tab-separated value (TSV) text files. The information is separated into rows and columns. Column data will be separated by tabs, while each new row will be separated by a hard return.

Contents of Each File

Each file will contain the subscription activity for each day. To help you understand a few common scenarios, below are a few examples:

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_uid`	String	Unique Vibes-specific Identifier for each wallet instance that's been installed.
`instance_event`	String	Type of wallet instance event. Valid values: Registered and Unregistered.
`registered_at`	Date/Time	The date/time when the wallet object was installed. Format example: "2017-04-05 14:30:00 UTC".
`unregistered_at`	Date/Time	Date/time when the wallet object was uninstalled. Format example: "2017-04-05 14:30:00 UTC".
`wallet_object_uid`	String	Unique identifier for the wallet object of this instance.
`wallet_provider`	String	String name for the installed provider. Valid values are Pass and Wallet.
`platform`	String	String for the specified device platform. Example: 'Android 7.1.1', 'iOS 10.3', and so on.
`company_id`	String	Unique string representing the id of your Vibes company account.
`campaign_uid`	String	Global Unique ID representing the campaign at Vibes.
`uuid`	String	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 created. Note: `uuid` = `wallet_item_id`
`current_flag`	Boolean	It is True if the instance is currently registered, or False if the instance has been unregistered.
`shared_instance`	Boolean	It is False if this the first installed instance for the Wallet object, or True otherwise.

Example File

Download an example file."