iFrame src URL

The src attribute specifies the address of the document to embed in an iframe, in this case, the URL of the co-branded TurboVote page you want to embed on your website.

<src="
     https://
     [partner].turbovote.org
     /[page-name]
     ?embed=window
     &partner=[partnerID]
     &placement=[placement]
     &r=[referralcode]
     &lang=[language]
">

The URL includes three distinct components that define our embedded experience:

• Domain: https://[partnername].turbovote.org

• Path: /[page-name]

• Query Parameters: ?parameter=value

Domain

To render your TurboVote co-branded partner experience, the iFrame src URL domain must include your partner hostname, e.g. “example” in https://example.turbovote.org.

Path

The URL path defines which TurboVote landing page, tool or guide you want to embed on your website. View full list of TurboVote URL Paths, but commonly used paths include:

Landing Pages

Tool Forms

Election Guides

Visit tvote.org/elections to find an election page to embed.

Query Parameters

TurboVote uses query parameters to

• set embed-specific instructions e.g. /?embed=window&partner=01gzpamk4zqm16ts3yjxt668tk&placement=vote-hub

• shape the TurboVote tool or guide experience e.g. what language to show by default /&lang=es 

• pass along  referral codes &r=springcampaign and metadata to associate with user accounts created on sign-up

View all TurboVote Query Parameters.

Embed-specific Query Parameters

Embed Type

embed sets the type of web page to render. Currently, window is the only value accepted and it’s required.

partner

partner passes along your unique numeric TurboVote partner ID partner which is required for TurboVote to render the embedded web experience on your site.

After consulting with our Partnerships team, you’ll be provided with embed codes that include this partner ID.

Embed Placement Referral Code

placement passes along a name or number used to reference where on your site the embed is integrated.

While optional, the embed codes provided by your partner manager will set the placement parameter using a term that references the landing page, tool or guide being embedded e.g. Election Reminders sign-up embed code will set placement parameter to “reminders-".

Work with your partner manager to append any existing placement IDs your site employs or to explore ways to leverage this flexible parameter.

Query Parameters Commonly Used in Embeds

lang

Sets the language used throughout the TurboVote experience.

Optional. If absent, TurboVote renders in English by default.

Values limited to:

r

Passes along a TurboVote Referral Code created to track accounts created if you choose to embed TurboVote on a page or site dedicated to a specific campaign. Optional.