Links
Comment on page

Bots

The Bot model

Key
Type
Description
id
String
The unique identifier for the bot which is given by Tiledesk.
name
String
The bot name.
id_project
String
The unique identifier of the project
type
String
The bot type. Permitted values: internal, external.
secret
String
The bot secret token used for JWT authentication.
createdBy
String
The unique identifier of the row creator
description
String
(Optional) The bot description.
url
String
(Optional) The bot external endpoint address
webhook_url
String
(Optional)
webhook_enabled
Boolean
(Optional)
trashed
Boolean
(Optional) The bot status.
attributes
Object
(Optional) The custom attributes which are set for the bot.
language
String
(Optional) The bot language.
createdAt
String
(Optional) The time when the bot was created.
public
Boolean
(Optional) The sharing status of the bot. Default false.
updatedAt
String
(Optional) The time when the bot was updated.
get
https://api.tiledesk.com/v3
/:project_id/bots
Get all bots
Example
curl -v -X GET -u [email protected]:123456 https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/bots

get
https://api.tiledesk.com/v3
/:project_id/bots/:id
Get a bot by id
Example
curl -v -X GET -u [email protected]:123456 https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/bots/5be9b2ecc72a050015e14951

get
https://api.tiledesk.com/v3
/:project_id/bots/exportjson/:id
Export a bot in JSON format
Example
curl -v -X GET -u [email protected]:123456 https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/bots/exportjson/5be9b2ecc72a050015e14951

post
https://api.tiledesk.com/v3
/:project_id/bots
Create a new bot
Example:
curl -v -X POST -H 'Content-Type: application/json' -u [email protected]:123456 -d '{"name":"bot1"}' https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/bots

post
https://api.tiledesk.com/v3
/:project_id/bots/fork/:id
Fork a bot
Example:
curl -v -X PUT -H 'Content-Type: application/json' -u [email protected]:123456 https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/bots/fork/5be9b2ecc72a050015e14951?public=false&projectid=5b55e806c93dde0014316e33

post
https://api.tiledesk.com/v3
/:project_id/bots/importjson/:id
Import whole bot from JSON
Example:
curl -v -X POST -H 'Content-Type: application/json' -u [email protected]:123456 -d "@path_to_file/bot.json" https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/bots/importjson/5be9b2ecc72a050015e14951

put
https://api.tiledesk.com/v3
/:project_id/bots/:id
Update a bot
Example:
curl -v -X PUT -H 'Content-Type: application/json' -u [email protected]:123456 -d '{"name":"bot1"}' https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/bots/5be9b2ecc72a050015e14951

delete
https://api.tiledesk.com/v3
/:project_id/bots/:id
Delete a bot
Example:
curl -v -X DELETE -H 'Content-Type: application/json' -u [email protected]:123456 https://api.tiledesk.com/v3/5b55e806c93dde00143163dd/bots/5be9b2ecc72a050015e14951
Last modified 13d ago