Embed configuration reference
When you place a signup form or an interactive widget on your own website, microsite, or landing page, you drop in a small embed snippet. That snippet exposes a set of attributes you can set to control which content loads, how it looks, and how it behaves. This page lists the attributes you are most likely to use.
Attribute names below are representative — (confirm the exact attribute names and casing in your account's embed snippet, since these are product-specific).
Reference
| Attribute | Type | Example value | Description |
|---|---|---|---|
data-embed-id | string (required) | frm_8fk2p9 | Identifier of the form or widget to load. Copy it from the embed dialog. |
data-type | enum | form | widget | survey | The kind of embedded content to render. |
data-theme | enum | light | dark | auto | Color scheme. auto follows the host page or device preference. |
data-width | string | 100% or 480px | Rendered width. Percentages are relative to the container. |
data-lang | string | en, fr, es | Language/locale used for labels and validation messages. |
data-prefill | key/value | email={{subscriber.email}} | Pre-populates fields, e.g. for a known subscriber. |
data-redirect | URL | https://example.com/thanks | Where to send the subscriber after a successful submit. |
data-utm-* | string | data-utm-source=newsletter | Passes campaign parameters through to reporting. |
data-consent | boolean | true | false | Whether to show the consent/opt-in checkbox. |
data-callback | function name | onEmbedReady | JavaScript hook fired on load and submit events. |
Notes
- Only
data-embed-idanddata-typeare essential; every other attribute has a sensible default, so start minimal and add options as needed. - Values are case-sensitive. Enumerated attributes (like
data-theme) reject unknown values and fall back to the default. - Use
data-prefillwith personalization tokens only when the page already knows the subscriber (for example, a link opened from a Broadcast). See Personalization tags. - Campaign parameters set with
data-utm-*flow into your metrics so submissions can be attributed correctly. See the Metrics dictionary. - Loading more than one embed on a page is supported; give each its own snippet and
data-embed-id.
Related
Canonical terms: Author, Edition, Folder (Project Folder), Broadcast. See the Glossary.