Engine's embed code can be placed in any order within your page, but for optimal user experience we recommend placing the script tag within the same div where the content is being rendered.
Basic Embed Syntax
PLEASE NOTE: Your Engine representative will provide you with your specific code snippet. Do not try to reproduce from the sample snippet outlined below.
This is a representative example of what our embed code looks like, and contains placeholders as defined below. Placeholders and will be replaced with precise values in the embed code provided to you.
Embed Components
Channel: placeholder that will be replaced with precise values in the embed code provided to you.
Zone: placeholder that will be replaced with precise values in the embed code provided to you.
Component Name: corresponds to the specific product or Engine experience type that's being rendered.
data-embed-type: enables Engine's auto-mount functionality; without this attribute, the component will not render.
Acceptable Value: "auto-mount"
Customization & Auto Sizing
The web component loads iFrame and will automatically fill the container. Embeds are rendered wherever you include our HTML tag on your page and will responsively scale to fill the space available to it.
Credit Cards Specific Syntax
Component Names
/web-component/credit-cards-search/: A full application-style flow where the user enters key info (income, credit, loan amount, etc.) and Engine returns personalized loan matches in-session. Use this when you want a “start here, answer a few questions, get matched” experience as the primary entry point.
/web-component/credit-cards-v2/: A browse-and-filter offers experience that leans on data you already have (or have prefilled) to show preview or pre-qualified offers up front. Use this when you want a “see your loan options and refine” experience inside an existing logged-in area or dashboard.
How to Implement Client Tags for Reporting & Customer Data Prefill
To add client tags in an embed, use the following syntax in the data-tags attribute within the embed script:
To prerefill fields in an embed, use the following syntax in the data-tags attribute within the embed script:
Sample Implementation
In the above example, clientId and source are available as tags for reporting purposes and the embed "credit rating" and "zipcode" fields will be prepopulated when the embed is rendered.
Supported Client Tag Keys
These are the keys that are currently fully supported across all Engine embed types. Please note that the keys below are case-sensitive:
agentId
campaignId
clientId
deviceid
medium
sourceId
subid
subid1
subid2
subid3
target
trafficsource
userid
If a different key is needed, please reach out to your Partner Manager - we may be able to accommodate, but adding nonstandard keys will increase the time it takes Engine to report Client Tag values back to you and is therefore not recommended.
Supported Keys for Credit Cards Customer Data Prefill
The following is a list of params that can be added to the Credit Cards embed code to prefill in the embed frontend:
Key
Purpose
app.annualIncome
Annual income (number)
app.firstName
First name
app.lastName
Last name
app.email
Email (valid formatting"
app.primaryPhone
Phone number
(XXX-XXX-XXXX; must be 10 digits or 11 starting with 1)