API Change log


  • No changes

Released 2021.09.07

  • Fixed: We limited webhooks' connection and execution time to 30 seconds.

Released 2021.08.24

  • The Chatbot API will now register an error if a webhook response takes longer than the 30-second timeout.
  • Fixed: The Chatbot API was not returning the displayed title if it was not set as the identifier. This is now fixed and we return it when the query matches it by natural language.

Released 2021.08.10

  • We improved the security of HTTP headers.
  • Added: We now track in the Chatbot session any webhook that does not pass the Chatbot API security validation (i.e. webhooks using untrusted URLs).

Released 2021.06.15

  • Fixed: The GET /surveys/{surveyId}/start was not returning the survey page id.

Released 2021.05.04

  • Fixed: We improved the validation of conversation message inputs.

Released 2021.04.06

  • Added: New GET /surveys/{surveyId}/start and POST /surveys/{surveyId}/submit endpoints that allow to programatically answer a survey using the Chatbot API.

Released 2021.03.23

  • Added: Security improvements for integrations using Domain Key.

Released 2021.02.09

  • Updated: We ensured that debug mode cannot be enabled in any case in Production.

Released 2021.01.26

  • Improved: We improved the RTT performance upon starting conversations.
  • Fixed: Multiple attribute groups in RTT are now formatted correctly.

Released 2021.01.12

  • Added: "Skip last question" is now split into two different settings for multiple and dialogs
  • Added: Performance improvements for RTT (cached actions and forms for direct calls)
  • Added: We return titles of matched contents (debug mode).
  • Improved: We improved webhook error feedback.
  • Fixed: The min score filter is applied as the first filter in content results.

Released 2020.12.23

  • Added: We improved internal API error reports.

Released 2020.12.09

  • Added: We added the messageList attribute in conversation history.
  • Fixed: We improved the performance of dialogs in RTT mode.

Released 2020.11.11

  • Fixed: There was an issue with the encoding of source names with special characters. This is now fixed.

Released 2020.10.28

  • Improved: As part of our continuous maintenance process, we reviewed and cleaned up the code to remove obsolete dependencies.

Released 2020.10.14

  • Added: Performance improvements with actions and forms in RTT

Released 2020.09.30

  • Added: The API now sends the source parameter to the surveys module. This makes it possible to track the source of the survey.

Released 2020.09.02

  • Updated: We updated the internal error reporting to specify when the API response timeout occurs in regular or real-time testing mode.

Released 2020.08.19

  • Updated: Previously, the Chatbot API did not allow you to set the Dashboard source when Real Time Testing was enabled but with the debugging mode disabled. This is no longer the case and you can now set the source.
  • Updated: The Multiple options label was updated in German to “Diese Antworten könnten Ihnen helfen:”

Released 2020.07.22

  • Fixed: The API did not properly insert variable values into content attributes in the Real Time Development environment. This is now fixed.
  • Fixed: The API did not properly apply the minimum score in the Real Time Development environment when the score was very low. This is now fixed.

Released 2020.07.01

  • Feature: Return the content condition data for all matched contents in debug mode.
  • Fixed: Results were not being returned in score order in real time development mode. This is now fixed.
  • Fixed: Attribute objects hidden in certain profiles were being returned in real time development mode. This is now fixed.
  • Fixed: Folder filtering was not being applied in real time development mode. This is now fixed.
  • Fixed: Improved performance in real time development mode.

Released 2020.06.10

  • New: Added debug profiler support
  • New: We now return NLP debug data in RTT mode
  • Fixed: There could be a crash on RTT subset search with no results. This is now fixed.

Released 2020.05.27

  • New: Added support for RTT variables and actions
  • New: Added support for RTT dynamic settings info
  • New: Added support for RTT dialogs
  • Fixed: There could be a crash when tracking uncompiled RTT content. This is now fixed.

Released 2020.04.29

  • Fixed: We fixed the formatting for multiple attribute groups.
  • Fixed: We eliminated double-logging of user questions within subsets.

Released 2020.04.15

  • New: Added minScore, cutNext and cutLast to general settings
  • New: Support for basic RTT features
  • New: Support for RTT forms
  • Fixed: Legacy ticket creation tracking feature

Released 2020.04.01

  • New: There are two new supported languages: Macedonian and Serbian.
  • Updated: We updated Inbenta rate-limits.
  • Fixed: The API now returns the list of unknown words detected in the user input.

Released 2020.03.18

  • Updated: Improved list type variables detection
  • New: There are four new supported languages: Bulgarian, Croatian, Icelandic and Lithuanian.

Released 2020.03.04

  • New: There are four new supported languages: Albanian, Bosnian, Latvian and Slovenian.
  • New: Accepting a time zone setting to return datetimes on a user's time zone in the conversation history.
  • Updated: form field names are now deprecated.

Released 2020.02.19

  • New: Added features and more flexibility in Chatbot actions to send and receive variables from webhooks or callbacks
  • New: Disable or customize webhook error messages

Released 2020.01.22

  • Updated: Improved efficiency when calculating the semantic weight of user inputs

Released 2020.01.08

  • New:  Improved info returned in the conversation/history API endpoint. In user interactions with revisitable links, the Direct Call name is returned instead of the non-user-friendly revisitable link value. In addition, user interactions with Option Id or Direct Call name now also return the message attribute instead of an empty string. This message is automatically inferred from Option Id or Direct Call name of the content.

Released 2019.12.18

  • New: The engine now returns the folder list hierarchy in POST conversation/variables/options and conversation/message when a folder list variable is asked to the user.

Released 2019.12.11

  • New: You can now enable or disable the "show end form" message with show_end_form.
  • New: You can now identify every intent and encrypt the intent identifier in revisitable links.
  • New: The conversation/history endpoint now returns sidewindow text.
  • Fixed: A bug was found where revisited contents with non existent dynamic redirect were not returned. This is now fixed.

Released 2019.11.27

  • Fixed: A bug was found with sending the conversation history to webhooks. This has been fixed and attaching the history to webhooks is now possible when an internal setting is enabled. 

Released 2019.11.13

  • New: We reduced the webhook timeout period to 30 seconds. This is because the API already had its own gateway timeout of 30 seconds, and PHP was still trying to execute webhooks after this period expired, and consuming resources. This reduction does not affect the Chatbot end-user experience and helps reduce the strain on our own system.
  • New: We added four new tracking events for registering when a user starts or abandons an intent and when the Chatbot fails to respond or responds to an intent. 
  • Fixed: A bug was found where the Chatbot was ignoring callbacks in the "No Results" content, even though callbacks were working in all other contents. This is now fixed and you can execute callbacks in the "No Results" content as intended.

Released 2019.10.30

  • Fixed: A bug was found where the API was not executing Direct Calls when the Direct Call name was made up entirely of numbers. As a result, Sessions > Details and Chatbot Debug were registering a Failed Direct Call. This is now fixed so that even if your Direct Call name is "3" the API will correctly execute it.

Released 2019.10.02

  • New: Added trusted webhook flag to actions.
  • New: Tracking of JS Callback.
  • Fixed: Validate option ID in chained and multiple behaviors.

Released 2019.09.18

  • Added: New language detector endpoint.

Released 2019.09.18

  • Fixed: We updated the way the Logs Obfuscator works to make sure that even very open regular expressions have no adverse effect on the Chatbot Session Details screen.

Released 2019.09.04

  • New: The Engine default minimum score is now set to 0.25.

Released 2019.08.21

  • Fixed: A bug was found where, when the dynamic setting TRACKING had an object in a content with an action, the Engine tracked the custom event twice: before showing the action and after. This is now fixed so that the event is only tracked once.

Released 2019.08.07

  • New: When the "TRACKING" dynamic setting is set in a content, a custom tracking is performed in the Session details.
  • New: Exposing Date header in CORS
  • New: Improved report of failed webhooks (added status code and new error types)
  • New: "No results" tracking
  • New: Handler in order to invalidate webhook responses setting invalid chatbot message responses

Released 2019.07.24

  • New: The new “Dynamic Redirect” feature allows you to configure the Chatbot to proactively show a particular dialog when it returns another intent as a matching result. This is particularly useful in dialogs, where the botmaster can proactively launch a hotel booking dialog, for example, after the matching process returns any content related to hotels or travel packages. This function allows you to reuse one or several dialogs across intents.
  • New: You can now set Chatbot to return 1-by-1 options without introduction text.
  • New: Added tracking of the number of options in multiple and chained results.

Released 2019.07.10

  • New: There is a new endpoint  in DELETE /conversation/variables. This endpoint allows you to reset variable values to default value.
  • Fixed: A bug was found where sometimes, after a search with multiple results, the engine tracked a subset search when an additional input matched to external results. This is now fixed.

Released 2019.06.26

  • New: Action field data is now also returned in basic data fields (Previously, it could only be returned with advanced fields such as the date picker).
  • Fixed: Input fields are now disabled when the bot asks if the user wants to abort the form. They were previously disabled after the user confirmed the intention to abort.

Released 2019.06.12

  • New: Chatbot can now track intent data
  • New: Added externalId and title attributes to external contents tracking.

Released 2019.05.29

  • New: Answers now return intent score info on intent start
  • Fixed: A bug was found where chained transitions were tracked with title as transition text. This is now fixed and they are tracked correctly with transition text.
  • Fixed: A bug was found where check questions with multiple values were not correctly tracked. This is now fixed.
  • Fixed: A bug was found where the engine was tracking bot message on actions without fields. This is now fixed so that it does not track bot messages, since no message is returned in these cases.

Released 2019.05.15

  • New: The Chatbot API can now track information about the SDK version used as part of the User information.
  • New: Ratings are now added to the Session tracking and visible in the "Session Details" section of Dashboards.
  • Fixed: A bug was found where, when a user rated a dialog node negatively, the click to the node was logged incorrectly in the new "Sessions > Details" and the "Ratings" dashboards. This is now fixed: the child node click is logged as "User click" and the rating is logged with the source "Chained Contents", without a user question.

Released 2019.05.07

  • New: Added support for Chatbot General Settings > Webhooks global configuration.
  • New: Added support for making dialog button links revisitable when contents contain a direct call and the links appear before automatic transitions or in dialogs without automatic transitions. 
  • Fixed: A bug was found where, when a content returned had a webhook or JS Callback and no data fields, the API did not return the answer text. However, the new Chatbot Sessions > Details screen was registering these answer texts. This is now fixed and answer texts that the bot does not return are no longer shown in the Sessions > Details Event Data column.
  • Updated tracking information in the API Routes

Released 2019.04.17

  • New: Tracking improvements effort for the new "Session details" screen in the Chatbot App.
  • New: New endpoint for the Chatbot API that allows you to capture multiple variables. For example, when a user is looking to purchase sneakers, you could capture the variables "color = red" and "brand = adidas" in a single request. For more information, see the new endpoint POST /conversation/variables/multiple in the API Routes documentation
  • Fixed: Tracking codes and no-rating flag are now properly returned on follow-up direct answer mapped as a content
  • Fixed: Returning Variable not found error message when trying to set a variable using API endpoint POST /conversation/variable
  • Fixed: The No subset match direct answer was tracked twice. This is now fixed and it is only tracked once.
  • Fixed: Reordered variable tracking when clicking multiple options button

Released 2019.04.03

  • New: New sys_total_negative_ratings system variable to count negative ratings in a conversation.
  • New: The /conversation endpoint of the Chatbot API now returns not only the sessionToken, but also the sessionId. This allows developers to retrieve and use sessionId to filter results in Dashboards.
  • Fixed: sys_total_negative_ratings system variable did not work as expected of the rating code was sent as a string. This is now fixed.
  • Fixed: Variable default capture on actions was previously tracked twice. This is now fixed to only be tracked once.

Released 2019.03.20

  • New: Dynamic List Variables. Bot masters can now create list variables with potential values provided during the conversation by webhooks. For example: after receiving the end-user's user login info the bot can launch a webhook to retrieve that user's shipping record. The bot can then offer the user a selector or a series of buttons prompting the user to choose one of these records. For full documentation, see Using a webhook to capture Multiple-value variables in Webhooks and the articles Using Multiple-value variables and Using Dynamic List Variables in the Inbenta Help Center.
  • Fixed: The "no-question" direct answer was always tracked when a conversation started with an empty message. This is now fixed.
  • Fixed: In some situation, errors in the capture of variables by webhooks were not tracked correctly. This is now fixed.
  • Fixed: A bug was found where the "follow-up-question" System Message, which the Chatbot shows after the user repeatedly enters incorrect information in a single form field, was being logged twice in Sessions > Details. This is now fixed so that it is only logged once.

Released 2019.03.06

  • A bug was found where variables that were set with the detection scope "Validation only" with default values were not actually set with these default values at the start of each conversation. This is now fixed.
  • When using an automatic transition in the Dialog Manager, we usually add at least one "condition". This makes sure that the Chatbot transitions to the following child node based on the value of a variable. We must always include a "default" node in case none of the previous conditions is met. 
    Our internal error reporting system showed that in a single project, the Chatbot returned an "Oooops" message and was then unable to continue the conversation. This was caused by an automatic transition that had only the "default" condition configured. We also found two other factors: the root content was the Welcome content, and it did not have an Action (form). 
    Since the objective of this configuration is to respond with two answers (the root node's answer and the child node's answer), a workaround was found where we added a second Answer Text object to the root content and removed the automatic transition followed by the default node. This issue is now fixed and contents can be followed by the default node only, however if the desired outcome is to achieve two responses, we recommend using multiple Answer Text objects, as the performance will be slightly faster.

Released 2019.02.20

  • Fixed: Ratings for chained contents, related contents and revisitable contents
  • New: Error tracking

Released 2019.02.06

  • New: Webhook tracking
  • New: Action fields tracking
  • New: NLS subset tracking
  • Improved: Tracking of revisitable related contents
  • Fixed: Invalid click and rate tracking codes now throw a 422 HTTP status code instead of a 500 code (For more information, see API error codes).
  • Fixed: Issues were found when capturing user input with umlauts using regex. This is now fixed.
  • Fixed: The Welcome message was being logged twice. This is no longer the case and it is now only logged once as expected.
  • Fixed: Setting the Chatbot with nonexistent profiles and using Direct Calls no longer causes an error.

Released 2019.01.23

  • New: Added variable-based content folder filtering.
  • Fixed: Improved missing dbms failover.

Released 2019.01.09

  • Clicks on related contents are logged now with the data key CLICK_RELATED.
  • The "Fromsite" filter in the Dashboard tabs is renamed to "Environment", and you can now filter Dashboards by Development and Preproduction environments in addition to the Production environment.

Released 2018.12.19

  • Fixed: There was a conflict with legacy form databases that sometimes caused content to be evaluated as an action with no data fields and not as a simple content. This is now resolved.
  • Documentation: We have updated the actionFields section of the Chatbot API Answer types to include information about the "datePicker" fieldType. The API returns this information when a date variable is used in Actions.

Released 2018.12.12

  • Setting the SDK to use the Development environment no longer causes a crash after the user clicks on a related content.
  • Added a new function to the Chatbot API that facilitates changing the conversation token signing keys.
  • Changed conversation session signing key to a new one. 
  • Fixed: Setting the Chatbot with nonexistent profiles and using Direct Calls no longer causes an error. 

Released 2018.11.07

  • Fixed: The data key "START" was logged as if it were in a production environment even though the Chatbot is in the development environment. Now it will be logged as "external test".
  • POST conversation/variables also accepting numeric values.
  • In order to track custom user_info and USER_BROWSER and not send extra API requests, we have added a "tracking" parameter in the conversation endpoint payload, with "userInfo" attribute in it. The keys defined inside this attribute will be tracked as USER_INFO. 
  • PHP session storage will now expire after 30 minutes of inactivity instead of 24 in order to standardize this session expiration time across all products.
  • Hotfix: Updated one of the libraries used by the API to ensure smooth transitions to/from Daylight Savings Time.

Released 2018.10.17

  • Added: New POST conversation/variables/options endpoint will return variables with a set of predefined options.

Released 2018.10.03

  • Fixed: Renamed system variable sys_consecutive_unanswered to sys_unanswered_consecutive. You can use this variable in automatic transitions in the Dialog Manager. 

Released 2018.09.19

  • Added: Support for System Variables 
  • Added: Support for Non-Matchable contents
  • Added: Support for No-results Dialog 

Released 2018.09.05

  • Added: Some Direct Answers can now be replaced by contents with the correctly configured Direct Call name. For more information, see Customizing direct answers.
  • Added: Automatic transitions now support new logical operators ("<", ">", "<=", ">=").
  • Fixed: Validation exceptions 422 were returning an HTTP status code 500; now they return a 422 HTTP status code.
  • Fixed: Direct Calls with empty message were failing. This was fixed.
  • Fixed: Automatic transitions were not working after a button transition. Now, they are allowed.
  • Fixed: Automatic transitions were not working after another automatic transition. Now, they are allowed.

Released 2018.08.08

  • Added: userInfo endpoint to API.

Released 2018.07.25

  • Added: Direct Calls now allow bot masters to force load a specific content in Chatbot.
  • Fixed: Ratings are only shown after the associated form action in instances with the Ratings dynamic setting created.
  • Improved tracking response to invalid tracking code: it now returns a 422 error instead of a 500, and provides more feedback with a dev-friendly message

Released 2018.07.11

  • Added: Variable captures in different scopes: always, within intent, form fields only and validation only
  • Added: Variable captures using regex
  • Added: Variable capture using lists
  • Added: Variable capture filtering using string, number or date data types
  • Added: Different behaviors for form fields: always ask, skip, confirm
  • Added: Use captured variable values when displaying contents
  • Added: Obfuscate in UI sensitive type variables
  • Added: Ratings display configuration using RATINGS dynamic setting: true, false, auto. (See Content Ratings for more info.)
  • Added: In multiple results from a dialog, do not show children if there is a parent with higher score
  • Added: New logic that permits the use of variable values within content attributes
  • Added: Webhooks send conversation session id
  • Added: PolarQuestions and MultipleChoiceQuestions returning attributes
  • Added: Get variables endpoint
  • Fixed: Forms return rating on end form instead of between answer and first form question
  • Fixed: no-subset-match direct answer in Catalan

Released 2018.05.30

  • Fixed: log ratings properly when multiple contents are shown

Released 2018.05.16

  • Fixed: API not returning rate code (hotfix)
  • Fixed: use default timezone in logs
  • Fixed: corrections in exit labels in all languages
  • Added support for grouped attributes

Released 2018.05.02

  • New Surveys endpoint

Released 2018.04.18

  • Added: support for multiple external results (KM and Search API)
  • Added: new attribute source to answer output, with type (chatbot/external_km/external_search) and name (base name defined in Federated Bot configurator)
  • Fixed: intents with no results are logged

Released 2018.04.04

  • Federated Search
  • Updated to AIML v3. It compares the scores from KB and AIML in order to return the best matching.
  • Added: After a subset of options with no matchings, bot will search in all bases than just Chatbot contents
  • Added: New direct answer on skipping all check questions (all-options-discarded)
  • Added: Generic bot messages now return specific flags in answers
  • Fixed: Added translations for 'yes' and 'no' options of check questions
  • Fixed: problems with AIML logs
  • Fixed: Data2Extract variables with non-lowercase names can detect pre-filled variable values