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.

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

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.

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.

Freshpaint Property
Vibe Parameter
Type
Requirement
Description

vibe_event_name

a

string

Recommended

Vibe event type. Valid values: install, lead, page_view, purchase, signup. If not set, Freshpaint will attempt to derive the event type by lowercasing the event name and inserting underscores at camelCase boundaries (e.g., "Purchase" → purchase, "PageView" → page_view). Note that space-separated names (e.g., "Page View") will not match. Events that cannot be resolved to a valid type will be dropped.

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.

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.

Last updated

Was this helpful?