# 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](/integrations/destinations/demand-side-platforms-dsps/vibe-conversions-api-early-access/vibe-reference.md).

{% hint style="warning" %}
The Vibe Conversions API destination is currently in Early Access. Please contact <support@freshpaint.io> for more information about this integration.
{% endhint %}

## Destination Info

* Supports [Track](/reference/developer/freshpaint-sdk-reference.md#track) calls
* Supports [HIPAA mode](/readme/hipaa-mode.md)
* Supports forwarding from the [Google Tag Manager Integration](/integrations/google-tag-manager-integration.md)
* Refer to this destination as **Vibe Conversions API** in the [Integrations object](/reference/developer/freshpaint-sdk-reference.md#using-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.

{% hint style="info" %}
When no suffix is specified, all configured Pixel IDs are selected for inclusion / exclusion.
{% endhint %}

* Connection Modes:

<table><thead><tr><th width="200.33333333333331" align="right"> </th><th data-type="checkbox">Client-side</th><th data-type="checkbox">Server-side</th></tr></thead><tbody><tr><td align="right">Web</td><td>false</td><td>true</td></tr><tr><td align="right">Mobile</td><td>false</td><td>true</td></tr><tr><td align="right">Server</td><td>false</td><td>true</td></tr></tbody></table>

## 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](https://www.vibe.co/dashboard/settings/tracking/web).
2. Click "Set up a Pixel".

<figure><img src="/files/6AwZwcn0Cvf9XL7rrC6u" alt="Image of the Vibe dashboard, highlighting the &#x22;Set up a pixel&#x22; button in the top right corner."><figcaption></figcaption></figure>

3. 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.

<figure><img src="/files/hDmjxMD8jsscA79tIMbb" alt="Installation methods with &#x22;Google Tag Manager&#x22; selected."><figcaption></figcaption></figure>

4. Select your advertiser.
5. Click "Continue" and copy the Pixel ID displayed on this page.

<figure><img src="/files/nf4Ls25B79VhYXgfiSJ2" alt="Vibe dashboard showing where to copy pixel ID"><figcaption></figcaption></figure>

### Configure the Vibe Conversions API destination in Freshpaint

1. Navigate to the [Freshpaint Destinations page](https://app.freshpaint.io/destinations/catalog).
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](/integrations/destinations/demand-side-platforms-dsps/vibe-conversions-api-early-access/vibe-reference.md#events).
5. Enable Vibe Conversions API.

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

<figure><img src="/files/1whCgjRodqsWo8oFW37k" alt="Image of the Freshpaint Vibe Conversions API configuration settings, showing where to set Pixel ID"><figcaption></figcaption></figure>

### 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](https://app.freshpaint.io/transformations) 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`).

<figure><img src="/files/g3cbez7ZFY5F6Qj6KxLI" alt="Freshpaint transformations page displaying a &#x22;Rename Event&#x22; transformation to rename event to a valid Vibe event type."><figcaption></figcaption></figure>

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".

<figure><img src="/files/yAErKlNWrFY04UwjXvgV" alt="Vibe Conversions API configuration page with &#x22;Configure&#x22; highlighted next to &#x22;recommended&#x22; and &#x22;required&#x22; properties"><figcaption></figcaption></figure>

### 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](https://app.freshpaint.io/event-verification) 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](https://www.vibe.co/dashboard/settings/tracking/web).
3. You should see conversion events appearing for your pixel.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.freshpaint.io/integrations/destinations/demand-side-platforms-dsps/vibe-conversions-api-early-access/vibe-quick-start-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.