Skip to end of metadata
Go to start of metadata

Last Updated: Monday, January 7, 2019


Search


Overview

Find the most common ways that you may want to integrate your systems with Vibes, then follow the links to the related Vibes documentation topics.


What Are You Looking To Do?

Related Integration Method

Extract and Import


Scenario One: Batch Extract File Integration FROM Vibes via SFTP - Receiving message reporting and details (inbound and outbound messages).Message Extract
Scenario Two: Batch Extract File Integration FROM Vibes via SFTP - Receiving mobile Subscription data (opt-ins, opt-outs, etc.,) to sync with an external database.Subscription Extract
Scenario Three: Batch Extract File Integration FROM Vibes via SFTP - Receiving message engagement reporting on URL click-through for Broadcast messages.URL Click Extract
Scenario Four: Batch Import File Integration TO Vibes via SFTP - Update a mobile Subscriber’s record in the Vibes database with additional data.Person Import
Scenario Five: Batch Import File Integration TO Vibes via SFTP - Send a one-to-many Broadcast to a targeted list of Subscribers (marketing alerts).Recipient List Import
Scenario Six: Batch Import File Integration TO Vibes via SFTP - Send a one-to-one Broadcast message to a single Subscriber (service alerts, account alerts, etc.,).Recipient List Import
View all Wallet instances that have been registered or unregistered since the last data extract by syncing Wallet data between Vibes Mobile Engagement Platform and a Customer Relationship Management (CRM) or Campaign Management system.

Wallet Instance Extract


View daily Wallet page views by syncing Wallet data between Vibes Mobile Engagement Platform and a Customer Relationship Management (CRM) or Campaign Management system.Wallet Page View Extract
View daily push messages by syncing push message data between Vibes Mobile Engagement Platform and a Customer Relationship Management (CRM) or Campaign Management system.Push Message Extract

Push


Push - Assign a given device to a specific Person as defined by their person_key or external_person_id.

Associate Push Device to Person
Push - Handle push integration with the Vibes Platform APIs.Installing the Android Push Notifications SDK
Push - Install the iOS Push Notifications SDK by using dependency managers or by manually integrating it.Installing the iOS Push Notifications SDK

Push - Retrieve a push device or list of push devices by its person_id, external_person_id, or vibes_device_id.  

Get Push Device
Push - Target by Person and Person custom fields.Associate Person to Device

Retrieve


Retrieve a callback by its callback_id.

Get a Callback

Retrieve a particular Acquisition campaign by its ID that is currently active in a company.

Get Acquisition Campaign

Retrieve a particular Mobile Wallet campaign by its wallet_id.

Get Mobile Wallet Campaign

Retrieve a Person by its person_id, person_key, or external_person_id.

Get a Person

Retrieve a specific Wallet message identified by the :wallet_message_id.

Get Wallet Message

Retrieve an array of all the Acquisition campaigns currently active in a company.

Get Acquisition Campaigns

Retrieve an array of all the Mobile Wallet campaigns currently active in the company.

Get Mobile Wallet Campaigns

Retrieve an array of all the previous Wallet messages on the campaign.

Get Wallet Messages

Retrieve an array of all the Wallet items currently active for the specified Mobile Wallet campaign.

Get Wallet Items

Retrieve the specific Wallet item identified by the :wallet_item_id.

Get Wallet Item

Create


Create a new Broadcast entity.

Create a Broadcast

Create a new callback record.

Create a Callback

Create a new Person record.

Add a Person

Create a new Wallet message and immediately begin sending it out to the targeted Wallet items.

Create Mobile Wallet Message

Create and/or update a Person record that is identified by the external_person_id.

Add or Update a Person

Create your test version of a callback event.

Create a Test Callback Event

Send


Send a one-to-many Broadcast to a targeted list of Subscribers (marketing alerts).Create a Broadcast API
Send a one-to-one Broadcast message to a single Subscriber (service alerts, account alerts, etc.,) via an Event API + API-triggered message executed in-Platform.Event Triggered Messages API

Return


Return all the confirmed Subscriptions for the specified Person.

Get Subscriptions of a Person

Return all the Subscription Lists in the Mobile Database for the specified company.

Get all Subscription Lists

Return an array of active Acquisition campaign references that point to the specified Subscription List.

Get Acquisition Campaigns

Return Broadcasts within the Mobile Database.

Search/Get Broadcasts

Return the Broadcast entity specified by the given :broadcast_id.

Get a Broadcast

Return the Person's Subscription information for the specified subscription_list.

Get a Person's Subscription Status for a List

Return the Subscription List object for the specified ID.

Get Subscription List

Update


Update an existing scheduled Broadcast with new data.

Update a Broadcast
Update a mobile Subscriber’s record in the Vibes database with additional data.Update a Person API

Receive


Receive mobile Subscriber data (email address, zip code, etc.,) to sync with an external database.Person API Callback Events
Receive mobile Subscription data (opt-ins, opt-outs, etc.,) to sync with an external database.Subscription Added Callback Events API

Get


Get an array of all issuances for the given code, or return an issuance entity if there was an available code.

Incentive Code Issuance API Methods

Get or redeem an incentive code.

Incentive Code Redemption API Methods

Get, show, create and update an incentive pool.

Incentive Pool API Methods

Perform


Perform a net change update to an existing Person record.

Update a Person

Perform a net change update to an existing Wallet item.

Update Mobile Wallet Item

Integrate


Integrate the Vibes Push Notifications SDK into an Android app.Integrating the Android Push Notifications SDK
Integrate the Vibes Push Notifications SDK into an iOS app.Integrating the iOS Push Notifications SDK

Search by person_id, external_person_id, or mdn.

Search for Pending Participants

Search for a Subscriber on the specified Subscription List by person_id, external_person_id or MDN.

Search for Subscriber

General


Add a Participant to have the specified Person added to the Acquisition campaign.

Add a Participant

Cancel an existing scheduled Broadcast specified by :broadcast_id, and prevent it from being sent.

Cancel/Delete a Broadcast
If you are using an opt-in confirmation prompt (Reply Y), use the Acquisition callbacks to understand when a Acquisition Participant changed (PENDING, CONFIRMED, CANCELED).Acquisition Callbacks

Issue or redeem an available code.

Incentive Code API Methods

List active and future callbacks.

List Callback

Locate Person record(s) by other search criteria. Valid search fields can be: mdn.

Find a Person

Remove the Person from the specified subscription_list.

Delete Subscription (Unsubscribe Person)

Set the end date of the callback to now and change it to inactive. If the start date of the callback was in the future, it will change that to now as well.

Delete a Callback

Submit a new event into the system.

Create Event
Subscribe a consumer to a mobile database from a web form.Add a Participant API


  • No labels