Deployment Management of Chatbots

Overview

Deployment Management controls the lifecycle of your bots across different environments. In EDDI, bots go through a create → configure → deploy workflow before they can process conversations.

Why Deployment Management?

Deployment management provides:

• Environment Isolation: Test bots without affecting production

• Version Control: Deploy specific bot versions, roll back if needed

• Gradual Rollout: Test in test environment, then unrestricted, finally restricted

• Zero-Downtime Updates: Deploy new versions while old ones are still running

• Audit Trail: Track what's deployed, when, and by whom

EDDI Environments

Environment	Purpose	Access Control
test	Development and testing	Typically unrestricted
unrestricted	Public/demo deployments	No authentication required
restricted	Production with authentication	Requires valid OAuth token

Deployment Lifecycle

1. CREATE Bot
   POST /botstore/bots
   → Bot exists but is NOT deployed

2. DEPLOY Bot
   POST /administration/unrestricted/deploy/bot123?version=1
   → Bot becomes active and can handle conversations

3. USE Bot
   POST /bots/unrestricted/bot123
   → Users can now interact with the bot

4. UPDATE Bot
   Create new version → Deploy new version
   → Old version still available if specified

5. UNDEPLOY Bot
   POST /administration/unrestricted/undeploy/bot123
   → Bot stops processing new conversations

Auto-Deploy Feature

• autoDeploy=true: Automatically deploy new versions when bot is updated

• autoDeploy=false: Manual deployment required for each version

This is useful for:

• Development: Auto-deploy to test for rapid iteration

• Production: Manual deployment to restricted for controlled releases

Checking Deployment Status

You can check:

• Single Bot Status: Is bot123 deployed in unrestricted?

• All Deployments: List all deployed bots across environments

• Version Info: Which version is currently deployed?

Deployment Operations

In this section we will discuss the deployment management of Chatbots, including deployment/undeployment, checking deployment status, and listing all deployed Chatbots.

After all the required resources for the chatbot have been created and configured (Dictionary, Behavior Rules, Output, Package, etc.) and the Chatbot is created through POST to /botstore/bots, deployment management is key to having granular control over deployed bots.

Deployment of a Chatbot :

The deployment of a specific chatbot is done through a POST to /administration/{environment}/deploy/{botId}

Deploy Chatbot REST API Endpoint

Element	Value
HTTP Method	POST
API endpoint	/administration/{environment}/deploy/{botId}
{environment}	(Path parameter):String deployment environment (e.g: restricted,unrestricted,test)
{botId}	(Path parameter):String id of the bot that you wish to deploy.

Example :

Request URL:

http://localhost:7070/administration/unrestricted/deploy/5aaf98e19f7dd421ac3c7de9?version=1&autoDeploy=true

Response Body:

no content

Response Code:

202

Response Headers:

{
"access-control-allow-origin": "*",
"date": "Mon, 19 Mar 2018 16:32:58 GMT",
"access-control-allow-headers": "authorization, Content-Type",
"content-length": "0",
"access-control-allow-methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
"content-type": null
}

Undeployment of a Chatbot

The undeployment of a specific chatbot is done through a POST to /administration/{environment}/undeploy/{botId}

Undeploy Chatbot REST API Endpoint

Element	Value
HTTP Method	POST
API endpoint	/administration/{environment}/undeploy/{botId}
{environment}	(Path parameter):String deployment environment (e.g: restricted,unrestricted,test)
{botId}	(Path parameter):String id of the bot that you wish to undeploy.

Example :

Undeploy a chatbot

Request URL

http://localhost:7070/administration/unrestricted/undeploy/5aaf98e19f7dd421ac3c7de9?version=1

Response Body

no content

Response Code

202

Response Headers

{
"access-control-allow-origin": "*",
"date": "Mon, 19 Mar 2018 16:38:36 GMT",
"access-control-allow-headers": "authorization, Content-Type",
"content-length": "0",
"access-control-allow-methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
"content-type": null

}

Check the deployment status of a chatbot:

Check the deployment status of a bot is done through a GET to /administration/{environment}/deploymentstatus/{botId}

Deployment status of a Chatbot REST API Endpoint

Element	Value
HTTP Method	GET
Api endpoint	/administration/{environment}/deploymentstatus/{botId}
{environment}	(Path parameter):String deployment environment (e.g: restricted,unrestricted,test)
{botId}	(Path parameter):String id of the bot that you wish to check its deployment status.
Response	NOT_FOUND, IN_PROGRESS, ERROR and READY.

Example_:_

Request URL

http://localhost:7070/administration/unrestricted/deploymentstatus/5aaf98e19f7dd421ac3c7de9?version=1

Response Body

READY

Response Code

200

Response Headers

List all deployed Chatbots:

{
"access-control-allow-origin": "*",
"date": "Mon, 19 Mar 2018 16:33:08 GMT",
"access-control-allow-headers": "authorization, Content-Type",
"content-length": "5",
"access-control-allow-methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
"content-type": "text/plain;charset=utf-8"
}

To list all the deployed Chatbots a GET to /administration/{environment}/deploymentstore/{botId}:

List of Deployed Chatbots REST API Endpoint

Element	Value
HTTP Method	GET
API endpoint	/deploymentstore/deployments

Example :

Request URL

http://localhost:7070/deploymentstore/deployments

Response Code

200

Response Body

[
  {
    "botId": "5aaf90e29f7dd421ac3c7dd4",
    "botVersion": 1,
    "environment": "unrestricted",
    "deploymentStatus": "deployed"
  },
  {
    "botId": "5aaf90e29f7dd421ac3c7dd4",
    "botVersion": 1,
    "environment": "restricted",
    "deploymentStatus": "deployed"
  },
  {
    "botId": "5aaf98e19f7dd421ac3c7de9",
    "botVersion": 1,
    "environment": "unrestricted",
    "deploymentStatus": "deployed"
  }
]

Response Headers

{
"access-control-allow-origin": "*",
"date": "Mon, 19 Mar 2018 16:33:29 GMT",
"access-control-allow-headers": "authorization, Content-Type",
"content-length": "414",
"access-control-allow-methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
"content-type": "application/json"
}