Context Injection

You can dynamically add user context to an embedded chat session using the window messaging API. This allows you to provide additional information that can enhance the chat experience.

Usage

Send a message to the embedded chat iframe using postMessage:

// Get a reference to your chat iframe
const chatIframe = document.getElementById("your-chat-iframe-id");

// Send context to the chat
chatIframe.contentWindow.postMessage({
  type: "addUserContext",
  context: "Your context information here"
}, "*");

Best Practices

• The context parameter must be a string and cannot be longer than 3000 characters, otherwise it will be truncated.
• The context will be associated with the current chat session
• Any previous context will be overwritten with the new context, INCLUDING auto-generated user information context, if enabled in the chatbot settings.
• The message must be sent to the correct iframe origin
• Make sure the iframe is fully loaded before sending messages to avoid errors. You can use the onload event handler if you need to add context on page load:

  chatIframe.onload = () => {
    // Send context after iframe is loaded
    chatIframe.contentWindow.postMessage({
      type: "addUserContext",
      context: "Your context information here"
    }, "*");
  };