When you’re ready to share your integration, you can publish it on Botpress Hub. This will make your integration publicly available to other Botpress users.

​
Publish your integration

1

Make your integration public

  1. From the Dashboard, navigate to integration’s page.
  2. Select Make Public:
  3. Accept the Hub terms and conditions.
2

Verify your integration

After making your bot public, you need to send it to Botpress for verification and approval.

Visual learner? Check out our YouTube guide on verifying your integration.

  1. Update your profile on Botpress.
  2. Update your integration’s display information.
  3. Ensure your integration asks users for any configuration parameters.
  4. Prepare an example bot that uses your integration.
  5. Send us your bot for approval.

​
Your workspace profile on Botpress Hub

When a user installs your app, your workspace information will be viewable by the user. Please ensure:

  1. Your Workspace has a url handle that represents you.
  2. You have a way for users to contact you, like an email or a website.
  3. Introduce yourself in the Workspace description (optional). This is the place for self-promotion.
  4. Add an icon to your Workspace that represents you (optional).

We suggest you create a Workspace specifically for publishing integrations, as this will make it easier to add collaborators to your workspace, and keep your production and dev environments separate.

​
Your integration’s public information

Do not include “Botpress” in your integration’s title or use the Botpress logo in your icon. Also, self-promotion is not allowed in the Hub.

Now we need to ensure the integration has all the assets and information it needs to be displayed on the Hub.

Your integration’s definition file integration.definition.ts file should contain:

  1. title: The display title of your integration for the hub.
  2. description: A succinct description of what your integration does.
  3. icon: The path to your svg icon usually icon.svg.
  4. readme: The path to your integration’s readme usually hub.md.

Make sure to have an icon and a readme in the root of your integration folder:

  1. icon.svg: Use a pertinent icon related to the problem you are solving.
  2. hub.md: It should contain an explanation of what the integration is, how to configure it, and how to use it. Please also add a link to git repo if your integration is open source, this drastically increase your chances of getting approved.

​
Your integration’s logic

Finally, we need to ensure your integration is robust and user-friendly.

  1. If your integration requires parameters to be configured: it should validate the parameters in the register method, and throw a RuntimeError if there is an issue.
import * as bpclient from "@botpress/client";

[...]

throw new RuntimeError(
	"Configuration Error! The Mixpanel token is not set. Please set it in your bot integration configuration."
);

This RuntimeError will be shown to the user in the Botpress Studio when they try to add your integration to their bot and there is an issue.

​
Submitting your integration for verification

When you’re done with above, we’d like to test your integration to ensure it works as expected, and that everything is in order. Whenever you’re ready , just click the Request Verification button on the banner.

To speed up the process, you can do the following proactively

  1. In your workspace, create a demonstration bot and configure your integration for it. We’ll use this to try out the integration.
  2. Add [email protected] to your workspace with Admin privileges.

Was this page helpful?

Suggest editsRaise issue