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.
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.
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.
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)
}
You can use our quick-start-module if you want to play around with the SDK in an empty Module.
From the project root, run yarn build:reference. This will copy the static assets into docs/reference/public/.
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.
Defines the list of content types supported by the bot
A Content Type describes a grouping of Content Elements @see ContentElement sharing the same properties. They can describe anything and everything – they most often are domain-specific to your bot. They also tells botpress how to display the content on various channels
Function that computes the visual representation of the text. This function resides in the javascript definition of the Content Type.
Hiding content types prevents users from adding these kind of elements via the Flow Editor. They are still visible in the Content Manager, and it's still possible to use these elements by specifying their name as a property "contentType" to ContentPickerWidget.
The jsonSchema used to validate the form data of the Content Elements.
Function that defines how a Content Type gets rendered on different channels. This function resides in the javascript definition of the Content Type.
Configuration file definition for the Converse API
The text limitation of the converse API requests
The timeout of the converse API requests
The direction of the event. An incoming event will register itself into the incoming middleware chain. An outgoing event will register itself into the outgoing middleware chain.
Returns the amount of elements from the starting position
An array of columns with direction to sort results
Can be info, error, success
An URL to redirect to when the notification is clicked
All available rollout strategies (how users interact with bots of that workspace) An invite code is permanent, meaning that it will be consumed once and will not be necessary for that user in the future
anonymous: Anyone can talk to bots anonymous-invite: Anyone with an invite code can talk to bots authenticated: Authenticated users will be automatically added to workspace as "chat user" (will then be "authorized") authenticated-invite: Authenticated users with an invite code will be added to workspace as "chat user" (will then be "authorized") authorized: Only authenticated users with an existing access to the workspace can talk to bots
Those are possible options you may enable when creating new routers
Check if user is authenticated before granting access
When checkAuthentication is enabled, set this to true to enforce permissions based on the method. GET/OPTIONS requests requires READ permissions, while all other requires WRITE permissions
Parse the body as JSON when possible
Only parses body which are urlencoded
Search parameters when querying content elements
Apply a filter to a specific field (instead of the 'search all' field)
Returns the amount of elements from the starting position
Only returns the items matching these ID
Search in elements id and form data
An array of columns with direction to sort results
The partial flow is only used to make some nodes optional. Those left empty will be automatically generated by the skill service.
A state is a mutable object that contains properties used by the dialog engine during a conversation. Properties like "nickname" or "nbOfConversations" are used during a conversation to execute flow logic. e.g. Navigating to a certain node when a condition is met.
This variable gives you access to the Botpress database via Knex. When developing modules, you can use this to create tables and manage data
The logger instance is automatically scoped to the calling module
Returns the current version of Botpress
Generated using TypeDoc
The configuration definition of a bot.