Vibe Quick Start Guide

This is a guide to help you get started on sending your conversion events to Vibe via Freshpaint. If you've already completed set up and are looking for more information, see Vibe Reference.

The Vibe Conversions API destination is currently in Early Access. Please contact [email protected] for more information about this integration.

Destination Info

• Supports Track calls

• Supports HIPAA mode

• Supports forwarding from the Google Tag Manager Integration

• Refer to this destination as Vibe Conversions API in the Integrations object

  • If you've configured multiple Pixel IDs, you can choose a specific one by suffixing the Pixel ID, such as: Vibe Conversions API::123456. You can retrieve this value from the Vibe configuration page for the Pixel ID of interest.

When no suffix is specified, all configured Pixel IDs are selected for inclusion / exclusion.

• Connection Modes:

	Client-side	Server-side
Web
Mobile
Server

Getting Started

What You'll Need

1. Your Vibe Pixel ID

2. Pixel ID configured in Freshpaint

3. Events in Freshpaint mapped to a valid Vibe event type

Get your Vibe Pixel ID

1. In your Vibe dashboard, navigate to Tracking → Web Pixel.

2. Click "Set up a Pixel".

1. Under Choose an installation method, select Google Tag Manager. You do not need to complete the Google Tag Manager installation - this step is only to locate your Pixel ID.

1. Select your advertiser.

2. Click "Continue" and copy the Pixel ID displayed on this page.

Configure the Vibe Conversions API destination in Freshpaint

1. Navigate to the Freshpaint Destinations page.

2. Search for the Vibe Conversions API destination.

3. Select Configure to paste your Pixel ID from the above steps.

4. Customers that use HIPAA mode should then configure the required, recommended, and recommended view-through properties. You can find all properties that the Freshpaint Vibe Conversions API integration supports here.

5. Enable Vibe Conversions API.

Once you've followed the steps above you can start sending events to Vibe Conversions API.

Setting up Conversion Events

Now that you've configured Freshpaint to connect to your Vibe pixel, you can send events to Vibe to track specific conversion types.

Vibe supports 5 conversion event types: install, lead, page_view, purchase, and signup. Freshpaint will automatically match an event to a Vibe event type if the event name, after lowercasing and inserting underscores at camelCase boundaries, exactly matches one of the valid types. For example, "Purchase", "purchase", and "PURCHASE" all match purchase, and "PageView" or "pageView" match page_view. Note that space-separated names like "Page View" will not match.

If you'd like to use an existing Freshpaint event whose name does not match a valid Vibe event type, you can use a Rename Event transformation to align the event name before it's sent to the destination. To do so:

1. Navigate to the Transformations page in Freshpaint.

2. Add a Rename Event transformation to map your existing event name to a valid Vibe event type (install, lead, page_view, purchase, or signup).

Events that cannot be resolved to a valid Vibe event type will be dropped.

If you are a HIPAA account, you will need to add event properties to the allowlist. If you are not a HIPAA account, you can skip this step.

1. Go to the Vibe Conversions API configuration page in Freshpaint.

2. Click "Configure" next to "Required Properties" and "Recommended Properties".

Confirm and Validate Events

Confirm and Validate Conversions in Freshpaint

1. Navigate to your site and trigger an event that should be sent to Vibe.

2. Navigate to the Event Verification tool in Freshpaint.

3. Select Vibe Conversions API and verify your event went through.

4. Verify the event is marked as OK or resolve any missing property issues.

Confirm and Validate Conversions in Vibe

To check whether Vibe is receiving your events:

1. Log in to your Vibe account.

2. Navigate to Tracking → Web Pixel.

3. You should see conversion events appearing for your pixel.