Changelog

Changes to the Elfa Apollo widget integration contract. The full documentation lives in the Partner Integration Guide.

21 Jul 2026

  • Added a scope note clarifying the integration guide covers the embedded (iframe) widget; the server-to-server Headless Widget API is documented separately at docs.elfa.ai/widget/overview.

15 May 2026

  • Added Auto Widget Order Execution (Backend Request) section with concrete payload examples (market/limit) and clarified integrator execution expectations.
  • Added partnerHmacSecret optional parameter to /embed/v1/get-user-token for per-user HMAC secret configuration.
  • Added comprehensive Widget Order Webhook Signature Validation section with Node.js and Python examples.
  • Enhanced Auto Widget Order Execution section to highlight signed webhook deliveries.

8 May 2026

  • Switched data-custom-labels keys to i18n flat-dotted naming convention. New keys: tab.labels.chat, tab.labels.insight, chat.landing.title.

1 May 2026

  • Added data-custom-labels attribute for branding string overrides (chat.landing.title). Requires custom_labels personalization flag.

17 Apr 2026

  • Added per-user usage limits: optional limits on /embed/v1/get-user-token, quota block in the response, and 429 QUOTA_EXCEEDED on the chat stream.

5 Apr 2026

  • Added elfa.apollo.widget.link_click PostMessage — fires on every chat link click.
  • Added data-block-link-navigation attribute to optionally prevent default link navigation.

19 Mar 2026

  • Added data-trade-callback attribute to enable Ask Elfa Trade button callbacks in embed mode.
  • Added elfa.apollo.widget.trade_callback to the PostMessage contract.

17 Mar 2026

  • Added guidance to use userData as chat personalization context.
  • Added data-widget-style attribute for custom CSS class overrides on the widget core container.
  • Added chat_message_sent to the PostMessage contract.

13 Mar 2026

  • Refined and reformatted the integration guide for readability.
  • Added and expanded Features/Personalization sections.
  • Added keyboard shortcut docs.
  • Added custom style override docs.

6 Mar 2026

  • Add data-lookup-preference support.

5 Feb 2026

  • Add data-launcher-icon-size support.

2 Feb 2026

  • Fix link to /get-user-token in the integration guide.