How to deploy Agents via Embed
To seamlessly integrate Cassidy Agents into your application via embed, follow these step-by-step instructions:
Navigate to the Agents page: Click on the "Agents" tab in the left sidebar to access your list of Agents.
Select the Agent: Choose the Agent you want to deploy via embed by clicking on its card or opening the ellipses (more options) menu and selecting "Edit."
Access the Deployments section: In the Agent's settings, navigate to the "Deployments" tab to configure and make Agents available in external tools.
Enable embedded chat deployment: Toggle on "Enable Embedded Chat Deployment".
Whitelist domains (optional): Click "Add Whitelisted Domain" to specify which domains are allowed to embed the Agent. You can add multiple domains and remove them as needed.
Enter Agent display name: In the "Agent Display Name" field, type in the name that will appear in the embedded chat. This name will be visible to users interacting with the Agent on your website.
Customize the first message: In the "First Message" field, enter the initial message that greets users when they open the embedded chat. This message can be used to welcome visitors, provide a brief introduction to the Agent's capabilities, or prompt users to ask a question.
Choose reference mode: Select the appropriate "Reference Mode" for your use case:
Disable References: Your Agent will not include any references in its responses.
Public Sources Only: Your Agent will include references only to publicly accessible sources, such as web pages.
Include All References (Default): Your Agent will provide references to all documents, including private ones, but users will need proper permissions to view them.
Generate Public Links: Your Agent will create public URLs for any referenced documents. Caution: This could expose sensitive information. Make sure your Agent does not have access to private documents.
Save settings: Click the "Save Settings" button to apply your configuration changes.
Copy embed code: In the "Embed Code" section, choose between the "Static IFrame Embed" or "Modal" options:
Static IFrame Embed: This option will display the Cassidy chat component directly on your website, always visible on the screen. It's ideal for providing quick access to the Agent without requiring user interaction.
Example code snippet
Preview on sample website
Modal: This option provides a button that, when clicked, will open the Cassidy chat as an overlay on top of your website's content. This is suitable for cases where you want to offer the Agent's help without taking up permanent space on the page.
Example code snippet
Preview on sample website
Copy the provided code snippet for your chosen embed method. You can click "Preview" to see what the embedded chat will look like.
Add to your website: Paste the embed code into your website's HTML where you want the chat to appear. If you're using a website builder, add the code to a custom HTML block or follow their instructions for embedding third-party scripts.
By following these steps, you can easily embed your Cassidy Agent on your website, allowing visitors to interact with it directly. This integration enables you to provide instant support, automate tasks, and enhance user engagement.