Activate event

get https://{environment}.digitalcx.com/event/{eventName}

Trigger event content as defined in the Conversational AI Cloud CMS. Useful for standardised triggers such as page loads, or conversation continuation.

Path Params

eventName

string

required

Name of the event as defined in the Conversational AI Cloud CMS.

Query Params

customerKey

string

required

Customer identifier used for authenticating the request.

projectKey

string

required

Project identifier used for authenticating the request, and to determine what project environment the interaction will take place in.

culture

string

required

Points to the culture of the project, which determines what content within the projects scope the answer will originate from.

session.id

string

The GUID which identifies what session the specific interaction (request) belongs in

channel

string

Determines the answer set that needs to be leveraged on matched articles, dialogs, and events. Find out more about the channel parameters behaviour here https://developers.cm.com/conversational-ai-cloud/docs/channels

classificationId

string

The ID for the classification

minFaqs

string

The minimum number of FAQ's added to the output

maxFaqs

string

The maximum number of FAQ's added to the output

Response

Response body

object

interactionId

string

Guid generated for each request to the Gateway API which is used to identify the Gateway request in subsequent requests and reporting.

sessionId

string

Guid generated for each request to the Gateway API. Points to the session linked to the interaction, and subsequent interactions.

culture

string

The culture used to select the answer content for this request.

outputs

array of objects

An array containing the output(s) from the Gateway based on the provided query.

outputs

object

kbaId

int32

Knowledge Base Article (Q&A or event) that was used in the answer.

interactionValue

string

The processed input used to achieve the answer presented in this output object.

dialogPath

string

The current path within the dialog. Only returned when the session/interaction is in a dialog.

faqQuestion

string

The question component of the FAQ.

kbaCategories

array of int32s

One or multiple categories the matched KBA is a part of within the knowledge base.

kbaCategories

outputParts

array of objects

outputParts

object

type

string

Type value indicating what sort of content is in the output object.

answer relatedFAQs

text

string

The answer text for this part of the output

projectConstants

array of integers

Array containing the ID values of the project constants present in the answer. Project constant values are already replaced in the answer text.

projectConstants

dialogOptions

array of strings

Array containing the dialog options as defined on the node of this dialog. This array is empty when the session is not in a dialog.

dialogOptions

faQs

array of objects

The FAQs matched to the provided query.

faQs

object

int32

The unique ID for the FAQ which can be used to retrieve the output for the FAQ in a subsequent call.

question

string

The question component of the FAQ.

categories

links

array of objects

An array containing all links present in this response.

links

object

int32

The replacement ID of the link as present in the replacement tag in the answer text.

text

string

The display text for the link

url

string

The url for the link object referencing an external resource

target

string

The link target as defined in the content, indicating how to process an interaction with the rendered link object.

_blank _top

images

array of objects

An array containing all images present in this response.

images

object

int32

The replacement ID of the image as present in the replacement tag in the answer text.

name

string

The name of the image as represented by the image URL.

title

string

The title of the image as defined on the content.

templateName

string

The name of the image response template. This value is always set to 'default'

default

linkId

int32

The replacement ID of the link as present in the 'Links' array. This ID references the link defined on the image.

additionalData

object

Additional metadata properties for an image

videos

array of objects

An array containing all videos present in this response.

videos

object

int32

The replacement ID of the video as present in the replacement tag in the answer text.

name

string

The name of the video as represented by the url URL.

url

string

The (public) url of the video.

source

string

Enum value indicating the source of the (public) video.

youtube vimeo

additionalData

object

Additional metadata properties for a video

metadata

object

Object containing variable metadata belonging to the answer or response. This object will can either be filled through the use of (answer) additions defined in the CMS, or dynamically on a web hook response.

inputs

object

An object containing the unprocessed, and processed input along with some metadata for the request. This object contains any relevant data related to how the provided Gateway response came to be.

originalInputText

string

The unprocessed input as provided to the Gateway API.

translatedInputText

string

The translated input text provided to the Gateway API. The original input was translated based on the culture specified in the inputLanguage property.

shortenedInputText

string

The shortened input as processed by the Long Question API product (beta)

inputLanguage

string

The (detected) language used to process this interaction. Not specified if no language detection, or translations took place for the interaction.

originalOutput

object

An object representing a response from the Gateway based on the provided query.

session

object

Conversation variables

key

string

Any conversation variable set to be exposed in the Conversational AI Cloud CMS).

Language

Credentials

Query

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.digitalcx.com/event/eventName \
3
     --header 'accept: application/json, standard'

Click Try It! to start a request and see the response here! Or choose an example:

application/json, standard

application/json, transactional dialog

200OK