Connectors / Service / Vibes

Vibes

Vibes

Vibes is a mobile marketing company that provides a variety of mobile marketing products and services, such as text message marketing, mobile wallet marketing, push notifications, and mobile web experiences.

Overview

Vibes provide a platform to automate engagement and manage all mobile communication channels to deliver dynamic consumer experiences.

API INFO: The Base URL used for the vibes connector is https://public-api.vibescm.com. More information can be found on their main API documentation (v1.0) site. This is where users will also be able to find the API Limitations page.
IMPORTANT!: If using the EU platform please use the following base URL https://public-api.eu.vibes.com/ .

Authentication

Within the workflow builder, highlight the Vibes connector.

In the Vibes connector properties panel to the right of the builder, click on the Authenticate tab and the 'Add new authentication' button.

This will result in a Tray.io authentication pop-up modal. The first page will ask you to name your authentication and select the type of authentication you wish to create ('Personal' or 'Organisational').

The next page asks you for your Vibes Username, Password, Company ID, and also which environment of the platform you are using.

You should select either the United States (US) or Europe (EU) environment and ensure it matches the Platform enviornment you are using.

In order to retrieve your company ID, please contact your Vibes account manager as stated in the API documentation here.

Once you have added these fields to your Tray.io authentication pop-up window, click the 'Create authentication' button.

Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Using the Raw HTTP Request ('Universal Operation')

As of version 1.0, you can effectively create your own operations.

This is a very powerful feature which you can put to use when there is an endpoint in Vibes which is not used by any of our operations.

To use this you will first of all need to research the endpoint in the Vibes API documentation v1.0, to find the exact format that Vibes will be expecting the endpoint to be passed in.

Note that you will only need to add the suffix to the endpoint, as the base URL will be automatically set (the base URL is picked up from the value you entered when you created your authentication).

The base URL for using Vibes in the US is: https://public-api.vibescm.com and https://public-api.eu.vibes.com for the EU platform.

For example, say that the 'List Wallet Campaigns' operation did not exist in our Vibes connector, and you wanted to use this endpoint. You would use the Vibes API docs to find the relevant endpoint - which in this case is a GET request called: /campaigns/wallet.

More details about this endpoint can be found here.

As you can see there is also the option to include a query parameter, should you wish to do so. So if you know what your method, endpoint and details of your query parameters are, you get the wallet campaigns information with the following settings:

Method: GET

Endpoint: /campaigns/wallet

Final outcome being: https://public-api.vibescm.com/companies/{company_id}/campaigns/wallet

Example Usage

TRAY POTENTIAL: Tray.io is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors. This demo which follows shows only one possible way of working with Tray.io and the vibes connector. Once you've finished working through this example please see our Introduction to working with data and jsonpaths page and Data Guide for more details.

Below is an example of a way in which you could potentially use the Vibes connector, to list all broadcasts and retrieve the information for each broadcast.

EXTRA AUTHS: In order to complete this workflow, you will also need to be authenticated with the vibes connector.

The steps will be as follows:

  1. Setup using a manual trigger and List all the scheduled broadcasts.
  2. Add a Loop connector to iterate through all the broadcasts from previous step.
  3. Get details of each broadcast.

Your completed workflow should look similar to this:

1 - Setup Trigger & List broadcasts

Select the Manual trigger from the trigger options available.

From the connectors panel on the left, add a Vibes connector to your workflow. Set the operation to 'List broadcasts'.

Feel free to re-name your steps as you go along to make things clearer for yourself and other users. The operation names themselves often suffice.

2 - Add a Loop connector

Next, search for the Loop collection connector within your connector panel, and drag it into your workflow as your next step. Set your operations to 'Loop list'.

The Loop Collection connector allows you to iterate through a list of results. In this example, we will use it to iterate through the data found within the previous Vibes connector step.

In order to specify the list you want to loop through, start by using the list mapping icon (found next to the list input field, within the properties panel) to generate the connector-snake.

While hovering over the 'List broadcasts' step (with the tail end of the connector-snake), select results from the list of output properties displayed. This will auto-populate a jsonpath within your list input field, and update the type selector to jsonpath.

For more clarification on the pathways you have available, open the Debug panel to view your step's Input and Output.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with Tray.io, please see our Intro page and Data Guide for more details.
CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.

When run, this workflow will iterate through the list of broadcats provided by the earlier step.

3 - Get broadcast

The last step is to drag a Vibes connector inside of the Loop Collection step itself. Set the operation to 'Get broadcast'. As you can see, the 'Broadcast ID' field is required.

Use the connector-snake to find the jsonpath for the 'Broadcast ID' field from the loop step. It should appear simillar to this: $.steps.loop-1.value.broadcast_id.

INTERPOLATION: When you wish to include JSON generated data within another input/ output/ result, use our Interpolation method as described here.

When run, the workflow will now iterate through the list of broadcasts, and get information for each broadcast.

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our Managing data best practices guide.

All Operations

Latest version:

1.2