The botpress messaging server provides a standardized messaging api to communicate with the following channels :
- Messenger
- Slack
- Teams
- Telegram
- Twilio
- Smooch
- Vonage
botpress.config.json
"messaging": {
"channels": {
"smooch": {
"enabled": true,
"version": "1.0.0",
"appId": "<APP_ID>",
"keyId": "<KEY_ID>",
"keySecret": "<SECRET_KEY>",
"webhookSecret": "<WEBHOOK_SECRET>"
}
}
}Webhook URL: <EXTERNAL_URL>/api/v1/messaging/webhooks/v1/<BOT_ID>/smooch
To access extra payload: event.payload.extra
services:
botpress:
env_file: .env
container_name: botpress
image: botpress/server:v12_31_8
command: /botpress/bp
expose:
- ${BOTPRESS_PORT}
environment:
- DATABASE_URL=postgres://${DB_USER}:${DB_PASSWORD}@postgres:${DB_PORT}/${DB_NAME}
- DATABASE_POOL=${DB_POOL}
- BPFS_STORAGE=database
- BP_MAX_SERVER_REBOOT_DELAY=5000
- BP_PRODUCTION=true
- EXTERNAL_URL=<EXTERNAL_URL>
- MESSAGING_LOGGING_ENABLED=true
- MESSAGING_ENDPOINT=http://messaging:${MESSAGING_PORT}
depends_on:
# UNCOMMENT THESE LINE AFTER DEFINE POSTGRES SERVICE
# postgres:
# condition: service_healthy
messaging:
condition: service_started
volumes:
- ./botpress/data:/botpress/data
networks:
- botpress-network
ports:
- "${BOTPRESS_PORT}:${BOTPRESS_PORT}"
extra_hosts:
- "host.docker.internal:host-gateway"
restart: unless-stopped
messaging:
env_file: .env
container_name: botpress-messaging
image: vinifsouza/botpress-messaging:0.0.1
environment:
- PORT=${MESSAGING_PORT}
- DATABASE_URL=postgres://${DB_USER}:${DB_PASSWORD}@postgres:${DB_PORT}/${DB_NAME}
- DATABASE_POOL=${DB_POOL}
- EXTERNAL_URL=<EXTERNAL_URL> # can be the same of botpress service
ports:
- ${MESSAGING_PORT}:${MESSAGING_PORT}
extra_hosts:
- "host.docker.internal:host-gateway"
networks:
- botpress-network- Yarn v1+ (https://yarnpkg.com/)
- Docker (https://www.docker.com/) and docker-compose (https://docs.docker.com/compose/)
- Install recommended VSCode extensions
- Optionally install tilt
The simplest way to run the setup locally would be with tilt.
> tilt upThen open http://localhost:10350 to use the tilt UI. Tilt will start 4 processes:
messaging: messaging server (port 3100)inject-build: inject script build that watches for changesinject-serve: serves the inject script built by theinject-buildprocess (port 8080)webchat: serves a live version of the webchat that uses theinject-serveserver (port 3543)
Note: The messaging client id inside the file packages/inject/example.html needs to be provider manually for now.
Otherwise, to start the messaging server, simply run
> yarn devTo easily make API calls to the server, use the misc/api.rest file
To create a binary of the Messaging server
> yarn packageTo run tests
> yarn testNote: to run a specific test suite, add a colon followed by the name of the suite name to the command above (e.g. To run integration tests: yarn test:int)
To lint the codebase
> yarn eslintTo format the codebase
> yarn prettierTo reset the codebase to its initial state
> yarn resetFor all other commands, please refer to the scripts of the root package.json
For more information about the different test suites, go here.
You can read the internal documentation here