Info |
---|
This document explains how to configure provides instructions for configuring chatbots in x-bees, integrating Webhookwith integrations available for Webhooks, AWS SQS, Dialogflow CX or , and OpenAI Assistant. Developer documentation: https://docs.wildix.com/. Created: August 2024 Permalink: https://wildix.atlassian.net/wiki/x/4APOAQ |
Table of Contents
Introduction
...
- Webhooks provide real-time communication by sending HTTP POST requests to a specified URL when certain events occur. This allows for immediate processing and response, making it ideal for time-sensitive interactions
- AWS SQS offers a reliable and scalable solution for message queuing, ensuring that even high volumes of chat events are handled efficiently. It decouples the processing of events, allowing your chatbot to manage requests asynchronously and at scale
- Dialogflow CX enhances the natural language understanding (NLU) of your chatbot, enabling complex and multi-turn conversations with users. This integration is well-suited for advanced dialog management and contextual responses
- OpenAI Assistant brings sophisticated natural language processing (NLP) capabilities. This integration is ideal for creating more human-like and contextually aware interactions
Note |
---|
Notes:
|
Bot creation
Note |
---|
It is possible to set up to 50 chatbots per organization. |
...
Target:
Enter the URL that the Webhook will use to send POST requests
Warning This URL should be publicly accessible and secured with a valid HTTPS certificate. It should be designed to accept HTTP POST requests with JSON payloads and respond with status codes in the 200-299 range as quickly as possible.
It's important to ensure that your Webhook endpoint can handle multiple identical calls in case of retries due to network or server failures. Chatbot platforms may attempt to redeliver event payloads up to 3 times if the initial delivery is unsuccessful.
Secret:
- The secret ensures that only requests from the Wildix system are accepted, preventing unauthorized access or potential security breaches. The secret key is included in the headers of each POST request sent by the Webhook. Your server should validate this key to ensure the request is legitimate before processing the event data
- The secret ensures that only requests from the Wildix system are accepted, preventing unauthorized access or potential security breaches. The secret key is included in the headers of each POST request sent by the Webhook. Your server should validate this key to ensure the request is legitimate before processing the event data
After creating the bot, click on Manage API keys to create API key:
- Click Create new API Key
- Enter a name for identification
- Click Create and copy the secret using the Click to reveal button
Note |
---|
You can configure a test Webhook bot using these instructions: https://docs.wildix.com/guides/2024/07/20/chatbot-simple/. |
AWS SQS
When configuring AWS SQS as the integration type, you need to specify the following fields to establish the connection between x-bees and your AWS SQS queue:
...
API Key:
The OpenAI API Key is a unique identifier that allows x-bees to authenticate with OpenAI's services. It grants access to the OpenAI API, enabling you to send requests and receive responses from the Assistant
Note Requirements for API Key:
- Resource:
Threads
- Restriction:
write
This means that to successfully use the OpenAI Assistant, your API key must have access to the "Threads" resource with write permissions.
- Resource:
Assistant ID:
- The OpeAI Assistant ID s a unique identifier of a specific OpenAI Assistant you created. It is used to direct the chatbot's requests to the correct OpenAI Assistant
...