API Docs

This are the api routes provided by the bot.

Get status information

GET http://localhost:3000/

Get status information about the availability of the bot. Can be used to monitor uptime.

200 Cake successfully retrieved.

{
    "message": "WekanChatBot up and running",
    "success": true
}

Wekan

Wekan Webhook Data documentation for further information.

Recieve webhook

POST http://localhost:3000/wekan

This path is used as outgoing webhook in wekan. Depending on settings chat users are notified. See wekan webhook data documentation (see above).

Headers

Name	Type	Description
x-wekan-token	string	The token provided by wekan while setting up the webhook.

200

403 The provided token was invalid or undefined.

{
  "message": "Invalid or non existent token",
  "success": false
}

Synology Chat

Incoming URL for messages sent to the bot

POST http://localhost:3000/synology/bot

URL used for Synology Outgoing Bot URL

Request Body

Name	Type	Description
text	string	The text sent by the user.
token	string	The synology chat bot token.

200