# Vibe Reference

This is a reference document for the Vibe destination. For information on how to set up this integration, see the [Vibe Quick Start Guide](/integrations/destinations/demand-side-platforms-dsps/vibe-conversions-api-early-access/vibe-quick-start-guide.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>

This is a reference document for the Vibe Conversions API destination. For information on how to set up this integration, see the [Vibe Conversions API Quick Start Guide](/integrations/destinations/demand-side-platforms-dsps/vibe-conversions-api-early-access/vibe-reference.md).

### Events

#### Required Properties

| Freshpaint Property | Vibe Parameter | Type   | Requirement | Description                                                                                      |
| ------------------- | -------------- | ------ | ----------- | ------------------------------------------------------------------------------------------------ |
| `$ip`               | `ip`           | string | Required    | IP address of the user who performed the action. Events are dropped if this property is missing. |

#### Recommended Properties

| Freshpaint Property | Vibe Parameter   | Type   | Requirement | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ------------------- | ---------------- | ------ | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `vibe_event_name`   | `a`              | string | Recommended | <p>Vibe event type. Valid values: <code>install</code>, <code>lead</code>, <code>page\_view</code>, <code>purchase</code>, <code>signup</code>. If not set, Freshpaint will attempt to derive the event type by lowercasing<br>the event name and inserting underscores at camelCase boundaries (e.g., "Purchase" → <code>purchase</code>, "PageView" → <code>page\_view</code>). Note that space-separated names<br>(e.g., "Page View") will not match. Events that cannot be resolved to a valid type will be dropped.</p> |
| `revenue`           | `ed.price_usd`   | number | Recommended | Purchase amount in USD. `revenue` takes precedence over `price_usd` if both are present. Recommended for purchase events.                                                                                                                                                                                                                                                                                                                                                                                                    |
| `order_id`          | `ed.purchase_id` | string | Recommended | Unique order identifier. `order_id` takes precedence over `purchase_id` if both are present. Recommended for purchase events.                                                                                                                                                                                                                                                                                                                                                                                                |

#### Recommended View-Through Properties

| Freshpaint Property | Vibe Parameter | Type   | Requirement | Description                                                                                             |
| ------------------- | -------------- | ------ | ----------- | ------------------------------------------------------------------------------------------------------- |
| `$user_agent`       | `ua`           | string | Optional    | User agent string of the user's browser or device. Automatically captured by Freshpaint when available. |


---

# 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-reference.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.