Botpress SDK

Botpress SDK allows you to create Botpress Modules that extends the functionalities of the platform. Botpress SDK exposes all the major methods that a Module needs to interact with the core.

We made sure that the SDK is always up-to-date with the latest version of Botpress. It will always match the current version of your Botpress installation.

Tip: For step-by-step instructions in how to install a Module or create one, see our Developer's Guide Module Section.

How to use Botpress SDK

To use the SDK in your Module, it has to be recognized by Botpress.

Tip: Before continuing, please refer to the Module Building section of our Developer's Guide to learn how to build your Module.

Definition File

The Botpress SDK definition file (botpress.d.ts) can be either copied manually from src/bp/sdk/botpress.d.ts or copied automatically while running the yarn build:modules in your project root.

Once you have the definition file ready, you can import it with import sdk from 'botpress/sdk' and use it in your code.

Example usage

import sdk from 'botpress/sdk'

...

async function sendNewMessage(botId, userId, conversationId, payload) {
  const event = sdk.IO.Event({
    botId,
    channel: 'web',
    direction: 'incoming',
    payload,
    target: userId,
    threadId: conversationId,
    type: payload.type
  })

  const message = await this.db.appendUserMessage(botId, userId, conversationId, persistedPayload)

  sdk.realtime.sendPayload(sdk.RealTimePayload.forVisitor(userId, 'webchat.message', message))
  return sdk.events.sendEvent(event)
}

Quick Start Module

You can use our quick-start-module if you want to play around with the SDK in an empty Module.

Build the SDK Reference

From the project root, run yarn build:reference. This will copy the static assets into docs/reference/public/.

Contribute

Our goal is to make sure that Botpress SDK is always well documented. If you find things you can improve or clarify, feel free to contribute to the Botpress SDK definition file.