Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Create a new Endpoint
Create a new Endpoint resource in a project.
curl --request POST \
--url 'https://api-trial.cognigy.ai/new/v2.0/endpoints?api_key=' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"foreignId": "<string>",
"channel": "webchat3",
"flowId": "<string>",
"localeId": "<string>",
"URLToken": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f",
"name": "New Endpoint",
"entrypoint": "667ed4ae16d66f47dc2a9400",
"active": true,
"nluConnectorId": "cognigy",
"useConversations": true,
"maskIPAddress": true,
"maskAnalytics": true,
"maskLogging": true,
"useContactProfiles": true,
"useAnalytics": true,
"useDashbotAnalytics": true,
"dashbotApikey": "<string>",
"dashbotPlatform": "<string>",
"disableInputSanitization": "<string>",
"disableSkipUriTags": "<string>",
"overrideSnapshotConnections": true,
"settings": {
"accessScope": "<string>",
"accessToken": "<string>",
"appId": "<string>",
"appSecret": "<string>",
"backgroundImageUrl": "<string>",
"basicAuthPassword": "<string>",
"basicAuthUser": "<string>",
"botUserId": "<string>",
"businessHours": {
"businessHours": [
{
"startTime": "<string>",
"endTime": "<string>",
"weekDay": "<string>"
}
],
"enabled": true,
"text": "<string>",
"mode": "<string>",
"timeZone": "<string>",
"title": "<string>"
},
"colorScheme": "<string>",
"connectionName": "<string>",
"customJSON": "<string>",
"designTemplate": 123,
"disableHtmlContentSanitization": true,
"disableInputAutocomplete": true,
"disableInputAutogrow": true,
"disableUrlButtonSanitization": true,
"enableGenericHTMLStyling": true,
"enableAsyncCommunication": true,
"engagementMessageText": "<string>",
"displayGetStartedButton": true,
"dynamicImageAspectRatio": true,
"enableCollectMetadata": true,
"enableConnectionStatusIndicator": true,
"enableDemoWebchat": true,
"enableFileUpload": true,
"enablePersistentMenu": true,
"enableRating": "onRequest",
"enableSTT": true,
"enableTTS": true,
"enableUnreadMessageBadge": true,
"enableUnreadMessagePreview": true,
"enableUnreadMessageSound": true,
"enableUnreadMessageTitleIndicator": true,
"enableTypingIndicator": true,
"facebookPageToken": "<string>",
"focusInputAfterPostback": true,
"getStartedButtonText": "<string>",
"getStartedPayload": "<string>",
"getStartedText": "<string>",
"getStartedData": "<string>",
"headerLogoUrl": "<string>",
"hubSecret": "<string>",
"inputAutogrowMaxRows": 123,
"inputPlaceholder": "<string>",
"language": "<string>",
"lineChannelAccessToken": "<string>",
"lineChannelSecret": "<string>",
"maintenance": {
"enabled": true,
"mode": "<string>",
"text": "<string>",
"title": "<string>"
},
"mergeContactProfiles": true,
"messageDelay": 123,
"messageLogoUrl": "<string>",
"overwriteWebchatBundleUrl": "<string>",
"ratingTitleText": "<string>",
"ratingCommentText": "<string>",
"ratingMessageHistoryRatingText": "<string>",
"ratingMessageHistoryCommentText": "<string>",
"reparseAlexaSlots": true,
"requestFacebookProfileData": true,
"sessionExpiration": 123,
"shouldOverwriteWebchatBundleUrl": true,
"showEngagementMessagesInChat": true,
"slackOAuthAccessToken": "<string>",
"slackVerifyToken": "<string>",
"sunshineConversationsChannelKeyId": "<string>",
"sunshineConversationsChannelSecret": "<string>",
"sunshineConversationsChannelUri": "<string>",
"tenantId": "<string>",
"updateContactProfileWithFacebookProfile": true,
"voice": "<string>",
"webhookUrl": "<string>",
"skill": {},
"persistentMenu": {}
},
"transformer": {
"abortOnError": true,
"transformer": "<string>",
"transpiledTransformer": "<string>",
"inputTransformerEnabled": true,
"outputTransformerEnabled": true,
"finalPingTransformerEnabled": true,
"notifyTransformerEnabled": true,
"injectTransformerEnabled": true
},
"handoverSettings": {
"provider": "cognigy",
"providerSettings": {
"forwardOnlyHandoverConversations": true,
"getQueueUpdates": true,
"apiVersion": "<string>",
"baseUrl": "<string>",
"apiAccessToken": "<string>",
"baseApiUrl": "<string>",
"realtimeAccessToken": "<string>",
"realtimeEndpointUrl": "<string>",
"webhookSecret": "<string>",
"botCategoryId": "<string>",
"agentCategoryId": "<string>",
"organizationId": "<string>",
"deploymentId": "<string>",
"buttonId": "<string>"
},
"agentAssistSettings": {
"copilotType": "none",
"agentAssistFlowId": "<string>",
"agentAssistConfigId": "<string>",
"enableTranscriptTile": true,
"enableTranscriptTileChatInput": true,
"redactTranscriptTileMessages": true,
"enableAgentCopilotAuthentication": true,
"agentCopilotAuthentication": "<string>",
"oAuth2Connection": "<string>"
}
},
"orgDataPrivacySettings": {
"enabled": true,
"useAnalytics": true,
"storeDataPayload": true,
"useContactProfiles": true,
"useConversations": true,
"maskIPAddress": true,
"maskAnalytics": true,
"maskLogging": true
},
"projectId": "<string>"
}
'{
"foreignId": "<string>",
"channel": "webchat3",
"flowId": "<string>",
"localeId": "<string>",
"URLToken": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f",
"name": "New Endpoint",
"entrypoint": "667ed4ae16d66f47dc2a9400",
"active": true,
"nluConnectorId": "cognigy",
"useConversations": true,
"maskIPAddress": true,
"maskAnalytics": true,
"maskLogging": true,
"useContactProfiles": true,
"useAnalytics": true,
"useDashbotAnalytics": true,
"dashbotApikey": "<string>",
"dashbotPlatform": "<string>",
"disableInputSanitization": "<string>",
"disableSkipUriTags": "<string>",
"overrideSnapshotConnections": true,
"settings": {
"accessScope": "<string>",
"accessToken": "<string>",
"appId": "<string>",
"appSecret": "<string>",
"backgroundImageUrl": "<string>",
"basicAuthPassword": "<string>",
"basicAuthUser": "<string>",
"botUserId": "<string>",
"businessHours": {
"businessHours": [
{
"startTime": "<string>",
"endTime": "<string>",
"weekDay": "<string>"
}
],
"enabled": true,
"text": "<string>",
"mode": "<string>",
"timeZone": "<string>",
"title": "<string>"
},
"colorScheme": "<string>",
"connectionName": "<string>",
"customJSON": "<string>",
"designTemplate": 123,
"disableHtmlContentSanitization": true,
"disableInputAutocomplete": true,
"disableInputAutogrow": true,
"disableUrlButtonSanitization": true,
"enableGenericHTMLStyling": true,
"enableAsyncCommunication": true,
"engagementMessageText": "<string>",
"displayGetStartedButton": true,
"dynamicImageAspectRatio": true,
"enableCollectMetadata": true,
"enableConnectionStatusIndicator": true,
"enableDemoWebchat": true,
"enableFileUpload": true,
"enablePersistentMenu": true,
"enableRating": "onRequest",
"enableSTT": true,
"enableTTS": true,
"enableUnreadMessageBadge": true,
"enableUnreadMessagePreview": true,
"enableUnreadMessageSound": true,
"enableUnreadMessageTitleIndicator": true,
"enableTypingIndicator": true,
"facebookPageToken": "<string>",
"focusInputAfterPostback": true,
"getStartedButtonText": "<string>",
"getStartedPayload": "<string>",
"getStartedText": "<string>",
"getStartedData": "<string>",
"headerLogoUrl": "<string>",
"hubSecret": "<string>",
"inputAutogrowMaxRows": 123,
"inputPlaceholder": "<string>",
"language": "<string>",
"lineChannelAccessToken": "<string>",
"lineChannelSecret": "<string>",
"maintenance": {
"enabled": true,
"mode": "<string>",
"text": "<string>",
"title": "<string>"
},
"mergeContactProfiles": true,
"messageDelay": 123,
"messageLogoUrl": "<string>",
"overwriteWebchatBundleUrl": "<string>",
"ratingTitleText": "<string>",
"ratingCommentText": "<string>",
"ratingMessageHistoryRatingText": "<string>",
"ratingMessageHistoryCommentText": "<string>",
"reparseAlexaSlots": true,
"requestFacebookProfileData": true,
"sessionExpiration": 123,
"shouldOverwriteWebchatBundleUrl": true,
"showEngagementMessagesInChat": true,
"slackOAuthAccessToken": "<string>",
"slackVerifyToken": "<string>",
"sunshineConversationsChannelKeyId": "<string>",
"sunshineConversationsChannelSecret": "<string>",
"sunshineConversationsChannelUri": "<string>",
"tenantId": "<string>",
"updateContactProfileWithFacebookProfile": true,
"voice": "<string>",
"webhookUrl": "<string>",
"skill": {},
"persistentMenu": {}
},
"transformer": {
"abortOnError": true,
"transformer": "<string>",
"transpiledTransformer": "<string>",
"inputTransformerEnabled": true,
"outputTransformerEnabled": true,
"finalPingTransformerEnabled": true,
"notifyTransformerEnabled": true,
"injectTransformerEnabled": true
},
"handoverSettings": {
"provider": "cognigy",
"providerSettings": {
"forwardOnlyHandoverConversations": true,
"getQueueUpdates": true,
"apiVersion": "<string>",
"baseUrl": "<string>",
"apiAccessToken": "<string>",
"baseApiUrl": "<string>",
"realtimeAccessToken": "<string>",
"realtimeEndpointUrl": "<string>",
"webhookSecret": "<string>",
"botCategoryId": "<string>",
"agentCategoryId": "<string>",
"organizationId": "<string>",
"deploymentId": "<string>",
"buttonId": "<string>"
},
"agentAssistSettings": {
"copilotType": "none",
"agentAssistFlowId": "<string>",
"agentAssistConfigId": "<string>",
"enableTranscriptTile": true,
"enableTranscriptTileChatInput": true,
"redactTranscriptTileMessages": true,
"enableAgentCopilotAuthentication": true,
"agentCopilotAuthentication": "<string>",
"oAuth2Connection": "<string>"
}
},
"orgDataPrivacySettings": {
"enabled": true,
"useAnalytics": true,
"storeDataPayload": true,
"useContactProfiles": true,
"useConversations": true,
"maskIPAddress": true,
"maskAnalytics": true,
"maskLogging": true
},
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}Authorizations
Supply the API Key in the HTTP-Header
Supply the API Key in the Url-Query
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
The default media type is application/hal+json. Use application/json for pure data results.
application/json, application/hal+json, application/xml, text/xml, text/csv Query Parameters
An Id of a resource within the corresponding project to copy from
24Body
facebook, alexa, slack, generic, inject, rest, realtime, socket, adminconsole, webchat2, dialogflow, twilio, twilio-sms, line, intercom, microsoftBotFramework, microsoftTeams, sunshineConversations, admin-webchat, avaya, nonConversational, voiceGateway2, amazonLex, workplace, webhook, abstractRest, userlike, ringCentralEngage, audioCodes, bandwidth, whatsapp, eightByEight, genesysBotConnector, niceCXOne, agentAssistVoice, webchat3, niceCXOneAAH, zoomContactCenter "webchat3"
The URLToken of the endpoint
"f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f"
The name of the endpoint
"New Endpoint"
The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.
"667ed4ae16d66f47dc2a9400"
Toggle whether the endpoint is active or not
The NLUConnector type
alexa, dialogflow, dialogflowBuiltIn, amazonLexBuiltIn, luis, watson, noNlu, cognigy, code, generativeAI, lex "cognigy"
Whether to collect conversations history for this endpoint
Whether to mask sensitive IP address in input object and analytics data for this endpoint
Whether to mask sensitive data in analytics for this endpoint
Whether to mask sensitive data in logs for this endpoint
Whether to use contact profiles for this endpoint
Whether we should store analytics for this endpoint
Whether we should use Dashbot to collect analytics
The apikey for the dashbot bot
If true, disables input text sanitization after Input Transformer
If true, disables skipping of uri tags
Show child attributes
Show child attributes
Show child attributes
Show child attributes
onRequest, always, once Show child attributes
Show child attributes
If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.
The transformer object as written by the user. This will be displayed in the UI since it includes typings.
The transformer object written by the user, but without typings. This will be executed.
Show child attributes
Show child attributes
cognigy, none, rce Show child attributes
Show child attributes
(rce) Whether to forward all conversations to the provider, or only the conversations that trigger a handover. If this setting is true, then we will only forward conversations were handover was triggered.
(rce) Indicates if queue updates should be enabled to receive events about the estimated wait time
(salesforce) Salesforce LiveAgent API Version
Base URL of the LiveAgent API Deployment
(rce) The API access token you can create within RCE
(rce) The API URL to your RCE installation
(rce) The access token for your rce source sdk source
(rce) The endpoint URL of your rce source sdk source
(rce) The secret used to secure webhooks in RCE
(rce) The ID of the category you use as the 'bot category' within RCE
(rce) The ID of the category you use as the 'bot category' within RCE
(salesforce) Salesforce Organization ID
(salesforce) Salesforce LiveAgent Deployment ID
(salesforce) Salesforce LiveAgent Chat Button ID
Show child attributes
Show child attributes
Copilot Type
none, workspace, whisper Copilot flow ID
Selected Copilot Config ReferenceId
Enable the transcript tile
Enable the chat input for transcript tile
Enable redaction of messages in transcript tile
Enable authentication for agent copilot
Authentication connection reference Id for agent copilot
OAuth2 Connection for Genesys Cloud
Organisation data privacy settings overwrite the ones defined on endpoint-level
Show child attributes
Show child attributes
Whether or not organisation data privacy settings are enabled
24Response
Returns Endpoint metadata object.
The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.
facebook, alexa, slack, generic, inject, rest, realtime, socket, adminconsole, webchat2, dialogflow, twilio, twilio-sms, line, intercom, microsoftBotFramework, microsoftTeams, sunshineConversations, admin-webchat, avaya, nonConversational, voiceGateway2, amazonLex, workplace, webhook, abstractRest, userlike, ringCentralEngage, audioCodes, bandwidth, whatsapp, eightByEight, genesysBotConnector, niceCXOne, agentAssistVoice, webchat3, niceCXOneAAH, zoomContactCenter "webchat3"
The URLToken of the endpoint
"f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f"
The name of the endpoint
"New Endpoint"
The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.
"667ed4ae16d66f47dc2a9400"
Toggle whether the endpoint is active or not
The NLUConnector type
alexa, dialogflow, dialogflowBuiltIn, amazonLexBuiltIn, luis, watson, noNlu, cognigy, code, generativeAI, lex "cognigy"
Whether to collect conversations history for this endpoint
Whether to mask sensitive IP address in input object and analytics data for this endpoint
Whether to mask sensitive data in analytics for this endpoint
Whether to mask sensitive data in logs for this endpoint
Whether to use contact profiles for this endpoint
Whether we should store analytics for this endpoint
Whether we should use Dashbot to collect analytics
The apikey for the dashbot bot
If true, disables input text sanitization after Input Transformer
If true, disables skipping of uri tags
Show child attributes
Show child attributes
Show child attributes
Show child attributes
onRequest, always, once Show child attributes
Show child attributes
If true, then we will abort the message processing if the transformer throws an error. Otherwise, we will continue with normal message processing in the event of an error.
The transformer object as written by the user. This will be displayed in the UI since it includes typings.
The transformer object written by the user, but without typings. This will be executed.
Show child attributes
Show child attributes
cognigy, none, rce Show child attributes
Show child attributes
(rce) Whether to forward all conversations to the provider, or only the conversations that trigger a handover. If this setting is true, then we will only forward conversations were handover was triggered.
(rce) Indicates if queue updates should be enabled to receive events about the estimated wait time
(salesforce) Salesforce LiveAgent API Version
Base URL of the LiveAgent API Deployment
(rce) The API access token you can create within RCE
(rce) The API URL to your RCE installation
(rce) The access token for your rce source sdk source
(rce) The endpoint URL of your rce source sdk source
(rce) The secret used to secure webhooks in RCE
(rce) The ID of the category you use as the 'bot category' within RCE
(rce) The ID of the category you use as the 'bot category' within RCE
(salesforce) Salesforce Organization ID
(salesforce) Salesforce LiveAgent Deployment ID
(salesforce) Salesforce LiveAgent Chat Button ID
Show child attributes
Show child attributes
Copilot Type
none, workspace, whisper Copilot flow ID
Selected Copilot Config ReferenceId
Enable the transcript tile
Enable the chat input for transcript tile
Enable redaction of messages in transcript tile
Enable authentication for agent copilot
Authentication connection reference Id for agent copilot
OAuth2 Connection for Genesys Cloud
Organisation data privacy settings overwrite the ones defined on endpoint-level
Show child attributes
Show child attributes
Whether or not organisation data privacy settings are enabled
24Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
2424curl --request POST \
--url 'https://api-trial.cognigy.ai/new/v2.0/endpoints?api_key=' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"foreignId": "<string>",
"channel": "webchat3",
"flowId": "<string>",
"localeId": "<string>",
"URLToken": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f",
"name": "New Endpoint",
"entrypoint": "667ed4ae16d66f47dc2a9400",
"active": true,
"nluConnectorId": "cognigy",
"useConversations": true,
"maskIPAddress": true,
"maskAnalytics": true,
"maskLogging": true,
"useContactProfiles": true,
"useAnalytics": true,
"useDashbotAnalytics": true,
"dashbotApikey": "<string>",
"dashbotPlatform": "<string>",
"disableInputSanitization": "<string>",
"disableSkipUriTags": "<string>",
"overrideSnapshotConnections": true,
"settings": {
"accessScope": "<string>",
"accessToken": "<string>",
"appId": "<string>",
"appSecret": "<string>",
"backgroundImageUrl": "<string>",
"basicAuthPassword": "<string>",
"basicAuthUser": "<string>",
"botUserId": "<string>",
"businessHours": {
"businessHours": [
{
"startTime": "<string>",
"endTime": "<string>",
"weekDay": "<string>"
}
],
"enabled": true,
"text": "<string>",
"mode": "<string>",
"timeZone": "<string>",
"title": "<string>"
},
"colorScheme": "<string>",
"connectionName": "<string>",
"customJSON": "<string>",
"designTemplate": 123,
"disableHtmlContentSanitization": true,
"disableInputAutocomplete": true,
"disableInputAutogrow": true,
"disableUrlButtonSanitization": true,
"enableGenericHTMLStyling": true,
"enableAsyncCommunication": true,
"engagementMessageText": "<string>",
"displayGetStartedButton": true,
"dynamicImageAspectRatio": true,
"enableCollectMetadata": true,
"enableConnectionStatusIndicator": true,
"enableDemoWebchat": true,
"enableFileUpload": true,
"enablePersistentMenu": true,
"enableRating": "onRequest",
"enableSTT": true,
"enableTTS": true,
"enableUnreadMessageBadge": true,
"enableUnreadMessagePreview": true,
"enableUnreadMessageSound": true,
"enableUnreadMessageTitleIndicator": true,
"enableTypingIndicator": true,
"facebookPageToken": "<string>",
"focusInputAfterPostback": true,
"getStartedButtonText": "<string>",
"getStartedPayload": "<string>",
"getStartedText": "<string>",
"getStartedData": "<string>",
"headerLogoUrl": "<string>",
"hubSecret": "<string>",
"inputAutogrowMaxRows": 123,
"inputPlaceholder": "<string>",
"language": "<string>",
"lineChannelAccessToken": "<string>",
"lineChannelSecret": "<string>",
"maintenance": {
"enabled": true,
"mode": "<string>",
"text": "<string>",
"title": "<string>"
},
"mergeContactProfiles": true,
"messageDelay": 123,
"messageLogoUrl": "<string>",
"overwriteWebchatBundleUrl": "<string>",
"ratingTitleText": "<string>",
"ratingCommentText": "<string>",
"ratingMessageHistoryRatingText": "<string>",
"ratingMessageHistoryCommentText": "<string>",
"reparseAlexaSlots": true,
"requestFacebookProfileData": true,
"sessionExpiration": 123,
"shouldOverwriteWebchatBundleUrl": true,
"showEngagementMessagesInChat": true,
"slackOAuthAccessToken": "<string>",
"slackVerifyToken": "<string>",
"sunshineConversationsChannelKeyId": "<string>",
"sunshineConversationsChannelSecret": "<string>",
"sunshineConversationsChannelUri": "<string>",
"tenantId": "<string>",
"updateContactProfileWithFacebookProfile": true,
"voice": "<string>",
"webhookUrl": "<string>",
"skill": {},
"persistentMenu": {}
},
"transformer": {
"abortOnError": true,
"transformer": "<string>",
"transpiledTransformer": "<string>",
"inputTransformerEnabled": true,
"outputTransformerEnabled": true,
"finalPingTransformerEnabled": true,
"notifyTransformerEnabled": true,
"injectTransformerEnabled": true
},
"handoverSettings": {
"provider": "cognigy",
"providerSettings": {
"forwardOnlyHandoverConversations": true,
"getQueueUpdates": true,
"apiVersion": "<string>",
"baseUrl": "<string>",
"apiAccessToken": "<string>",
"baseApiUrl": "<string>",
"realtimeAccessToken": "<string>",
"realtimeEndpointUrl": "<string>",
"webhookSecret": "<string>",
"botCategoryId": "<string>",
"agentCategoryId": "<string>",
"organizationId": "<string>",
"deploymentId": "<string>",
"buttonId": "<string>"
},
"agentAssistSettings": {
"copilotType": "none",
"agentAssistFlowId": "<string>",
"agentAssistConfigId": "<string>",
"enableTranscriptTile": true,
"enableTranscriptTileChatInput": true,
"redactTranscriptTileMessages": true,
"enableAgentCopilotAuthentication": true,
"agentCopilotAuthentication": "<string>",
"oAuth2Connection": "<string>"
}
},
"orgDataPrivacySettings": {
"enabled": true,
"useAnalytics": true,
"storeDataPayload": true,
"useContactProfiles": true,
"useConversations": true,
"maskIPAddress": true,
"maskAnalytics": true,
"maskLogging": true
},
"projectId": "<string>"
}
'{
"foreignId": "<string>",
"channel": "webchat3",
"flowId": "<string>",
"localeId": "<string>",
"URLToken": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f",
"name": "New Endpoint",
"entrypoint": "667ed4ae16d66f47dc2a9400",
"active": true,
"nluConnectorId": "cognigy",
"useConversations": true,
"maskIPAddress": true,
"maskAnalytics": true,
"maskLogging": true,
"useContactProfiles": true,
"useAnalytics": true,
"useDashbotAnalytics": true,
"dashbotApikey": "<string>",
"dashbotPlatform": "<string>",
"disableInputSanitization": "<string>",
"disableSkipUriTags": "<string>",
"overrideSnapshotConnections": true,
"settings": {
"accessScope": "<string>",
"accessToken": "<string>",
"appId": "<string>",
"appSecret": "<string>",
"backgroundImageUrl": "<string>",
"basicAuthPassword": "<string>",
"basicAuthUser": "<string>",
"botUserId": "<string>",
"businessHours": {
"businessHours": [
{
"startTime": "<string>",
"endTime": "<string>",
"weekDay": "<string>"
}
],
"enabled": true,
"text": "<string>",
"mode": "<string>",
"timeZone": "<string>",
"title": "<string>"
},
"colorScheme": "<string>",
"connectionName": "<string>",
"customJSON": "<string>",
"designTemplate": 123,
"disableHtmlContentSanitization": true,
"disableInputAutocomplete": true,
"disableInputAutogrow": true,
"disableUrlButtonSanitization": true,
"enableGenericHTMLStyling": true,
"enableAsyncCommunication": true,
"engagementMessageText": "<string>",
"displayGetStartedButton": true,
"dynamicImageAspectRatio": true,
"enableCollectMetadata": true,
"enableConnectionStatusIndicator": true,
"enableDemoWebchat": true,
"enableFileUpload": true,
"enablePersistentMenu": true,
"enableRating": "onRequest",
"enableSTT": true,
"enableTTS": true,
"enableUnreadMessageBadge": true,
"enableUnreadMessagePreview": true,
"enableUnreadMessageSound": true,
"enableUnreadMessageTitleIndicator": true,
"enableTypingIndicator": true,
"facebookPageToken": "<string>",
"focusInputAfterPostback": true,
"getStartedButtonText": "<string>",
"getStartedPayload": "<string>",
"getStartedText": "<string>",
"getStartedData": "<string>",
"headerLogoUrl": "<string>",
"hubSecret": "<string>",
"inputAutogrowMaxRows": 123,
"inputPlaceholder": "<string>",
"language": "<string>",
"lineChannelAccessToken": "<string>",
"lineChannelSecret": "<string>",
"maintenance": {
"enabled": true,
"mode": "<string>",
"text": "<string>",
"title": "<string>"
},
"mergeContactProfiles": true,
"messageDelay": 123,
"messageLogoUrl": "<string>",
"overwriteWebchatBundleUrl": "<string>",
"ratingTitleText": "<string>",
"ratingCommentText": "<string>",
"ratingMessageHistoryRatingText": "<string>",
"ratingMessageHistoryCommentText": "<string>",
"reparseAlexaSlots": true,
"requestFacebookProfileData": true,
"sessionExpiration": 123,
"shouldOverwriteWebchatBundleUrl": true,
"showEngagementMessagesInChat": true,
"slackOAuthAccessToken": "<string>",
"slackVerifyToken": "<string>",
"sunshineConversationsChannelKeyId": "<string>",
"sunshineConversationsChannelSecret": "<string>",
"sunshineConversationsChannelUri": "<string>",
"tenantId": "<string>",
"updateContactProfileWithFacebookProfile": true,
"voice": "<string>",
"webhookUrl": "<string>",
"skill": {},
"persistentMenu": {}
},
"transformer": {
"abortOnError": true,
"transformer": "<string>",
"transpiledTransformer": "<string>",
"inputTransformerEnabled": true,
"outputTransformerEnabled": true,
"finalPingTransformerEnabled": true,
"notifyTransformerEnabled": true,
"injectTransformerEnabled": true
},
"handoverSettings": {
"provider": "cognigy",
"providerSettings": {
"forwardOnlyHandoverConversations": true,
"getQueueUpdates": true,
"apiVersion": "<string>",
"baseUrl": "<string>",
"apiAccessToken": "<string>",
"baseApiUrl": "<string>",
"realtimeAccessToken": "<string>",
"realtimeEndpointUrl": "<string>",
"webhookSecret": "<string>",
"botCategoryId": "<string>",
"agentCategoryId": "<string>",
"organizationId": "<string>",
"deploymentId": "<string>",
"buttonId": "<string>"
},
"agentAssistSettings": {
"copilotType": "none",
"agentAssistFlowId": "<string>",
"agentAssistConfigId": "<string>",
"enableTranscriptTile": true,
"enableTranscriptTileChatInput": true,
"redactTranscriptTileMessages": true,
"enableAgentCopilotAuthentication": true,
"agentCopilotAuthentication": "<string>",
"oAuth2Connection": "<string>"
}
},
"orgDataPrivacySettings": {
"enabled": true,
"useAnalytics": true,
"storeDataPayload": true,
"useContactProfiles": true,
"useConversations": true,
"maskIPAddress": true,
"maskAnalytics": true,
"maskLogging": true
},
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}