Skip to main content
GET
/
v2.0
/
endpoints
/
{endpointId}
Get an Endpoint
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "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

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
endpointId
string
required

The Id of the Endpoint

Required string length: 24

Response

Returns Endpoint 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.

​
foreignId
string
​
channel
enum<string>
Available options:
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
Example:

"webchat3"

​
flowId
string
​
localeId
string
​
URLToken
string

The URLToken of the endpoint

Example:

"f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f"

​
name
string

The name of the endpoint

Example:

"New Endpoint"

​
entrypoint
string

The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.

Example:

"667ed4ae16d66f47dc2a9400"

​
active
boolean

Toggle whether the endpoint is active or not

​
nluConnectorId

The NLUConnector type

Available options:
alexa,
dialogflow,
dialogflowBuiltIn,
amazonLexBuiltIn,
luis,
watson,
noNlu,
cognigy,
code,
generativeAI,
lex
Example:

"cognigy"

​
useConversations
boolean

Whether to collect conversations history for this endpoint

​
maskIPAddress
boolean

Whether to mask sensitive IP address in input object and analytics data for this endpoint

​
maskAnalytics
boolean

Whether to mask sensitive data in analytics for this endpoint

​
maskLogging
boolean

Whether to mask sensitive data in logs for this endpoint

​
useContactProfiles
boolean

Whether to use contact profiles for this endpoint

​
useAnalytics
boolean

Whether we should store analytics for this endpoint

​
useDashbotAnalytics
boolean

Whether we should use Dashbot to collect analytics

​
dashbotApikey
string

The apikey for the dashbot bot

​
dashbotPlatform
string
​
disableInputSanitization
string

If true, disables input text sanitization after Input Transformer

​
disableSkipUriTags
string

If true, disables skipping of uri tags

​
overrideSnapshotConnections
boolean
​
settings
object
​
transformer
object
​
handoverSettings
object
​
orgDataPrivacySettings
object

Organisation data privacy settings overwrite the ones defined on endpoint-level

​
_id
string
Required string length: 24
​
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
createdBy
string
Required string length: 24
​
lastChangedBy
string
Required string length: 24
⌘I