Beeswax
Upload audience segments to Beeswax (FreeWheel) for programmatic advertising. Sync your warehouse audiences directly to Beeswax’s bidding platform for precise ad targeting.
Prerequisites
- A Beeswax account with API access
- Your Beeswax buzz key (the subdomain used to access the Buzz API)
- Your Beeswax account email and password
Permissions
Your Beeswax account must have permissions to:
- Create and manage segments
- Access the Buzz REST API
- Upload segment data
Authentication
Beeswax uses email and password authentication via the Buzz REST API.
- Log in to your Beeswax account
- Note your buzz key — this is the subdomain in your Beeswax API URL (e.g.,
my-companyinmy-company.api.beeswax.com) - In Zeotap, enter your Beeswax account email and password
Configuration
| Field | Type | Required | Description |
|---|---|---|---|
| Buzz Key | Text | Yes | Your Beeswax buzz key (the subdomain before .api.beeswax.com). Example: my-company |
| API Environment | Select | Yes | Production or Sandbox. Default: Production |
Target Settings
| Field | Type | Required | Description |
|---|---|---|---|
| Segment Name | Text | Yes | Name for the audience segment |
| Segment ID | Text | No | Existing segment ID. Leave blank to create a new segment |
| User ID Type | Select | Yes | The type of user identifier for segment matching. Options: Customer ID, HEM, IDFA, IDFA MD5, IDFA SHA1, Advertising ID, AD ID MD5, AD ID SHA1, IP Address. Default: Customer ID |
Supported Operations
Sync Modes
This destination is audience-only and does not support standard data sync modes.
Audience Sync Modes
| Mode | Supported |
|---|---|
| Add | Yes |
| Remove | Yes |
| Mirror | Yes |
| Upsert | Yes |
Features
- Field Mapping: No
- Schema Introspection: No
Required Mapping Fields
No field mapping is required. Zeotap uses the external_id or email field from your model to identify users in Beeswax. When using HEM (Hashed Email) as the user ID type, emails are automatically normalized and SHA256-hashed before upload.
How It Works
- Authentication: Zeotap authenticates with the Beeswax Buzz API using your email and password to establish a session
- Segment creation: If no segment ID is provided, Zeotap creates a new segment with the specified name (or finds an existing one with the same name to avoid duplicates)
- User upload: User identifiers are uploaded to the segment via the
segment_updateAPI endpoint in batches of up to 1,000 users per request - Add/Remove operations: Based on the sync mode, users are added to or removed from the segment using
ADD_SEGMENTSorREMOVE_SEGMENTSoperations - Mirror mode: In mirror mode, Zeotap compares the current audience with the previous sync and automatically adds new members and removes members no longer in the audience
User ID Types
Beeswax supports multiple identifier types for matching users to segments:
| ID Type | Description |
|---|---|
| Customer ID | Your own internal customer identifier |
| HEM | Hashed Email — emails are automatically SHA256-hashed by Zeotap |
| IDFA | Apple Identifier for Advertisers |
| IDFA MD5 / IDFA SHA1 | MD5 or SHA1 hashed IDFA |
| Advertising ID | Google Advertising ID (GAID) |
| AD ID MD5 / AD ID SHA1 | MD5 or SHA1 hashed Google Advertising ID |
| IP Address | User IP address |
Rate Limits
The Beeswax Buzz API enforces rate limits on the authentication endpoint and segment operations. Zeotap uploads data in batches of up to 1,000 users per request and processes batches sequentially to stay within limits. The segment_update endpoint is designed for updates of fewer than 1,000 users per API call. For larger audiences, Beeswax recommends using the file-based segment_upload endpoint, which can handle files with hundreds of millions of records.
Best Practices
- Use Customer ID or HEM for the most reliable matching across devices
- Prefer larger, less frequent syncs over many small syncs — Beeswax processes larger uploads more efficiently
- Keep segment names descriptive to easily identify them in the Beeswax platform
- Use mirror mode for audiences that change frequently to keep segment membership accurate
- Avoid alternating add and remove operations — Beeswax processes same-type operations more efficiently when submitted consecutively
Troubleshooting
Authentication failed
Verify your email and password are correct. Ensure your Beeswax account has API access enabled. The authentication endpoint is rate-limited, so wait a few minutes before retrying if you see repeated failures.
Invalid buzz key
The buzz key is the subdomain in your Beeswax API URL. For example, if you access Beeswax at my-company.api.beeswax.com, your buzz key is my-company. Do not include the full URL.
Segment not found
If you specified a segment ID that does not exist, the sync will fail. Double-check the segment ID in your Beeswax account, or leave the segment ID blank to create a new segment automatically.
Users not appearing in segment
Segment updates may take some time to process and become available for targeting. If users are not appearing after several hours, verify that the user ID type matches the identifiers in your data.
Sandbox vs Production
Ensure you selected the correct API environment. Sandbox data is not visible in production and vice versa. Use the sandbox environment for testing before syncing to production.
Rate limit errors
If you encounter rate limit errors (HTTP 429), reduce your sync frequency. Zeotap processes batches sequentially, but very large audiences synced frequently may exceed Beeswax’s rate limits.