Integrations
Overview
Our platform offers flexible integration options to fit various business needs, including custom API integrations and an easily embeddable chat widget. Whether you're looking to automate workflows or enhance user interactions, our tools are designed to seamlessly connect with your existing systems.
Custom API Integration
Initiating a Conversation
Use our API to start a conversation by creating a new session. You'll need to provide a flow ID and version ID to initiate this process. Here's how you can make the request:
curl -X POST "https://api.infinizeflow.com/sessions" \
-H "Content-Type: application/json" \
-d '{"flowId": "your_flow_id", "versionId": "your_version_id"}'
A conversation is continued as follows:
curl -X POST "https://api.infinizeflow.com/sessions" \
-H "Content-Type: application/json" \
-d '{"sessionId": "your_session_id", "sessionKey": "your_session_key", "input": "user_input"}'
Key Parameters
- flowId and versionId: Required to specify which flow and version to initiate.
- sessionId and sessionKey: These are returned upon starting a session and are used for subsequent requests to handle the conversation state and authentication.
- input: The users response.
- data: Initial data object provided for a flow.
This setup allows your applications to interact dynamically with our services, handling user inputs and system responses efficiently.
Chat Widget Integration
Embedding the Chat Widget
Incorporate our chat widget directly into your web pages or user interfaces with just a few lines of code. Customize the appearance and functionality using URL hash parameters. Here’s an example URL to include in your site:
<iframe src="https://widgets.infinizeflow.com/chat#flowId=[FLOW_ID]&versionId=[VERSION_ID]&background=white&foreground=lightgray&text=black&inputBackground=white" width="350" height="600" style="border:none;"></iframe>
Customization Parameters
Adjust the look and feel of the chat widget with these parameters:
- Colors: Customize the colors to match your branding.
background
: Background color of the widget.inputBackground
: Background color of the input area.border
: Border color.foreground
: Foreground color, e.g. for chat bubbles.text
: Text color.highlight
: Color for highlighting interactive elements.
- Captions: Modify default texts to fit your context.
labelLeft
: Text for the left bubble label.labelRight
: Text for the right bubble label.placeholder
: Placeholder text for the input field.
Furthermore, an additional state
parameter can be included, which is accessible within the flow.
The Publish Dialog simplifies integration by providing ready-to-use code snippets.