Table of Contents
Overview
Buzz supports extensive white labeling capabilities, where the Buzz UI appearance can be changed and also set behind a CNAME, such as bidder.customername.com. In order to white label a Buzz instance, please follow the steps outlined below.
UI Settings
The sections of the UI that can be rebranded are labeled in the screenshot and detailed in the table below. Share the system fields you want to white label with your Beeswax representative. If needed, these settings can also be applied across all accounts through a configuration that can be made by Beeswax Support.
API Note: These changes cannot be made via the REST API.
System Field | Value | Numbered label on image | Effect |
Main Header | Hex colour string | 1 | Color for main navigation bar |
Button and Links | Hex colour string | 2 | Color for table header and primary button |
Text | Hex colour string | 4 | Color for navigation bar text |
Custom Logo Image | URL string | 5 | Image to use for website icon / favicon |
Logo | URL string | 6 | Image to use for logo |
Page Title | String | 7 | Browser page title |
Beeswax can also apply these settings to the login page. To have these settings applied, contact your Beeswax Account Representative for assistance.
Email Settings
Buzz sends out emails to users for the following processes: Alert emails, Query Tool scheduled reports, Reporting scheduled reports, user creation and password reset. The email address and email content can be white labeled for all these processes, with the exception of reports sent from Report Builder where the ‘from email address’ is always set to the bidderreport.com domain.
The parts of the email that can be rebranded are labeled in the screenshot and detailed in the table below, the example provided is a user creation email.
To white label emails sent from Buzz, please follow the below steps:
- Share the email address you wish emails to come from with your Beeswax rep. Beeswax will send a verification email to that address, please click on the link within the email to finalise the set up.
- Note: Depending on your firewall settings, Beeswax Engineering may need to generate DKIM records and send the record set to you to configure on your end. Configuring DKIM records is a way for your server to register the signature that Beeswax adds to the emails.
- To white label the contents of the email, please provide the below details:
System Field | Value | Numbered label on image | Effect |
Email Logo | URL String | 1 | Logo to use in email templates |
Project Name | String | 2 | Project name to use in email templates, e.g. "My Bidder" |
Project Website | URL String | 3 | URL to link to in emails |
Email Sender | String | 4 | The sender for emails from this system e.g. email@mybidder.com |
Email ‘From Name’ | String | 5 | The name of the sender for emails from this system, e.g. ‘My Bidder’ |
Email ‘From Address’ | String | N/A | From address for emails, if different from the above ‘Email Sender’. Must be a valid email address. |
From Address Name | String | N/A | From address for system alerts and emails, if different from above ‘Email From Name’. Not an email address. |
Bidder UI URL | String | 6 | Any links in the email directing the user to the UI will use this domain for the landing page. This should match your CNAME bidder domain, discussed below. |
Bidder Domain Settings / CNAME
To white label the bidder domain, create a CNAME record and verify CNAME ownership.
- Share the desired domain name with your Beeswax rep.
- Your Beeswax representative will request an SSL certificate from AWS for the CNAME provided and generate a validation CNAME DNS record
- Your Beeswax representative will return the CNAME DNS record, which contains the following details:
- name
- type: CNAME
- value
- Create a CNAME record using the information provided above to verify ownership of the domain within 72 hours, after which the verification will fail. The procedure for adding CNAME records can vary depending on the DNS service provider.
- If verification fails, we will need to restart all processes starting from Step 2.
- Create a secondary CNAME record for the URL that is preferred for the UI (e.g. "mybidder.customer.com") and point it to ".beeswax.com"
- Once verification is complete, Beeswax will finalise the CNAME deployment
Additional Notes
The following Buzz features cannot be white labeled:
- The Buzz REST API endpoint cannot use a CNAME
- Creative previews
- The cookie syncing process
- Segment Tags
- Postback URLs
- Conversion/Event Tags