Docs SDK reference Configuration options

Configuration Options

All script tag attributes and dashboard settings that control elNudge behaviour on your site.

elNudge can be configured at two levels: script tag attributes (set in HTML, applied immediately on load) and dashboard settings (set in the app, applied to all sessions). When both are set, dashboard settings take precedence.

Script tag attributes

These attributes go directly on the <script> tag.

<script
  src="https://cdn.elnudge.com/v1/sdk.js"
  data-site-key="sk_live_YOUR_SITE_KEY"
  data-debug="true"
  data-quiet-zones="/checkout/*,/blog/*,/privacy"
  async
></script>

data-site-key

Required. Your site's unique identifier.

ValueDescription
sk_live_XXXXXXXXProduction key — nudges fire to real visitors
sk_test_XXXXXXXXTest key — events logged, nudges suppressed

The site key is a public identifier. It is safe to include in client-side HTML.

Get your key from the dashboard under Settings → API Keys.

data-debug

Optional. Default: false.

When set to "true", every event the SDK fires is printed to the browser console with the prefix [elNudge].

data-debug="true"

Example console output with debug enabled:

[elNudge] SDK ready — session ses_01HXXXXX
[elNudge] event PAGE_VIEW { url: "...", referrer: "...", title: "..." }
[elNudge] event SCROLL_DEPTH { depth: 50 }
[elNudge] event CART_ADD { product_id: "prod_abc", price: 2999, ... }

Remove this attribute before deploying to production. Debug output is verbose and is visible in your customers' browser consoles.

Test keys (sk_test_) enable debug mode automatically, even without this attribute.

data-quiet-zones

Optional. Default: none.

A comma-separated list of URL path patterns where the nudge widget is suppressed. Matching uses glob-style wildcards.

data-quiet-zones="/checkout/*,/blog/*,/privacy,/terms,/account/*"
PatternMatches
/checkout/*/checkout/, /checkout/shipping, /checkout/payment, etc.
/blog/*/blog/, /blog/post-title, etc.
/privacyExact path match only

The session continues and events are still tracked in quiet zones — the AI still builds a picture of intent. Only the widget is suppressed.

Note: Quiet zones set in the dashboard (Engagement Rules → Quiet Zones) override this attribute. Manage them in the dashboard if you want to update them without a code deploy.


Dashboard settings

These are configured in app.elnudge.com under your site settings. They apply to all visitors and always take precedence over script tag attributes if there is a conflict.

Quiet zones

Dashboard → Engagement Rules → Quiet Zones

The same glob-pattern list as data-quiet-zones, managed from the dashboard. Updating here takes effect within seconds — no code deploy needed.

Agent name

Dashboard → Agent → Name

The display name shown in the chat widget header. Defaults to "elNudge Assistant". Set this to match your brand (e.g. "Aria from YourStore").

Widget position

Dashboard → Agent → Widget Position

OptionDescription
Bottom-rightDefault
Bottom-leftUseful if other widgets occupy the bottom-right corner

Persona

Dashboard → Agent → Persona

A natural-language description of how the AI should present itself — tone, focus areas, and topics to avoid. This shapes every AI response.

Example persona:

You are a friendly sales assistant for a premium electronics store.
Focus on helping customers find the right product for their budget.
Do not discuss competitor products or pricing.

Voice

Dashboard → Agent → Voice

Toggle voice responses on or off. Voice is enabled by default for supported browsers (Chrome, Edge, Safari). When disabled, the widget always uses text chat regardless of browser capability.

Note: Firefox does not support the Web Speech API. Visitors on Firefox always receive text-only nudges regardless of this setting.


Configuration precedence

Dashboard settings
    ↓  override
Script tag attributes
    ↓  override
SDK defaults

If you set data-quiet-zones in the script tag AND configure quiet zones in the dashboard, the dashboard list applies. The script tag attribute is ignored.