What is Webflow

Webflow is a visual web development platform that enables users to design, build, and launch websites without the need for coding.

Get an API key

  1. Go to the Inkeep Dashboard
  2. Select your project under Projects
  3. Go to the Integrations tab
  4. Click on Create integration
  5. Select Web
  6. Provide a Name and URL (optional) for the integration
  7. Click on Create
  8. Click the Example < /> button to get your API key and view suggested settings

Connect the script

  1. Navigate to Site settings (not the designer)
  2. Open the Custom code tab
  3. Add the below to the Head code section
<script id="inkeep-script" src="https://unpkg.com/@inkeep/widgets-embed@0.2.288/dist/embed.js" type="module" defer></script>

Creating the container

Next, you need to add a container for the widget. You can do this using the built-in Webflow designer.

Add the placeholder

Add a container to your navigation bar where the search bar will be placed:

Set the container ID

Set the ID of the container to inkeepSearchBar:

Configure the widget

Go back to Site settings and navigate to Custom code. Add the below in the Footer code section.

<script type="text/javascript" defer>
  const widgetContainer = document.getElementById("inkeepSearchBar");

  const addInkeepWidget = function () {
    const inkeepScript = document.getElementById("inkeep-script");

    inkeepScript.addEventListener("load", () => {
      const inkeepWidget = Inkeep().embed({
        componentType: "SearchBar",
        targetElement: widgetContainer,
        properties: {
          stylesheetUrls: ['/path/to/stylesheets'], // optional
          baseSettings: {
            apiKey: "INKEEP_API_KEY", // required
            integrationId: "INKEEP_INTEGRATION_ID", // required
            organizationId: "INKEEP_ORGANIZATION_ID", // required
            primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
            organizationDisplayName: "Inkeep",
            // ...optional settings
          },
          modalSettings: {
            // optional settings
          },
          searchSettings: {
            // optional settings
          },
          aiChatSettings: {
            // optional settings
            botAvatarSrcUrl: "https://mydomain.com/mylogo", // use your own bot avatar
            quickQuestions: [
              "Example question 1?",
              "Example question 2?",
              "Example question 3?",
            ],
          },
        },
      });
    });
  };

  addInkeepWidget(); // initialize the widget
</script>

Press Save to apply your settings.

For a full list of customizations, check out the Search Bar documentation.