v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Endpoints

Create an Endpoint

Creates an Endpoint in a Project.

post/v2.0/endpoints

Query parameters

resourceIdstring

An Id of a resource within the corresponding project to copy from

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

foreignIdstring

channel'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' | 'mcpServer'

flowIdstring

localeIdstring

URLTokenstring

The URLToken of the endpoint

namestring

The name of the endpoint

entrypointstring

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

activeboolean

Toggle whether the endpoint is active or not

useConversationsboolean

Whether to collect conversations history for this endpoint

maskIPAddressboolean

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

maskAnalyticsboolean

Whether to mask sensitive data in analytics for this endpoint

maskLoggingboolean

Whether to mask sensitive data in logs for this endpoint

useContactProfilesboolean

Whether to use contact profiles for this endpoint

useAnalyticsboolean

Whether we should store analytics for this endpoint

useDashbotAnalyticsboolean

Whether we should use Dashbot to collect analytics

dashbotApikeystring

The apikey for the dashbot bot

dashbotPlatformstring

disableInputSanitizationstring

If true, disables input text sanitization after Input Transformer

disableSkipUriTagsstring

If true, disables skipping of uri tags

overrideSnapshotConnectionsboolean

projectIdstring

The unique identifier for the Project.

Example request

{
  "channel": "webchat3",
  "URLToken": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f",
  "name": "New Endpoint",
  "entrypoint": "667ed4ae16d66f47dc2a9400",
  "nluConnectorId": "cognigy"
}

Response

Returns the Endpoint metadata object.

foreignIdstring

channel'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' | 'mcpServer'

flowIdstring

localeIdstring

URLTokenstring

The URLToken of the endpoint

namestring

The name of the endpoint

entrypointstring

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

activeboolean

Toggle whether the endpoint is active or not

useConversationsboolean

Whether to collect conversations history for this endpoint

maskIPAddressboolean

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

maskAnalyticsboolean

Whether to mask sensitive data in analytics for this endpoint

maskLoggingboolean

Whether to mask sensitive data in logs for this endpoint

useContactProfilesboolean

Whether to use contact profiles for this endpoint

useAnalyticsboolean

Whether we should store analytics for this endpoint

useDashbotAnalyticsboolean

Whether we should use Dashbot to collect analytics

dashbotApikeystring

The apikey for the dashbot bot

dashbotPlatformstring

disableInputSanitizationstring

If true, disables input text sanitization after Input Transformer

disableSkipUriTagsstring

If true, disables skipping of uri tags

overrideSnapshotConnectionsboolean

_idstring

createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring

lastChangedBystring

Example response

{
  "channel": "webchat3",
  "URLToken": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f",
  "name": "New Endpoint",
  "entrypoint": "667ed4ae16d66f47dc2a9400",
  "nluConnectorId": "cognigy",
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}