Connect Botpress with Hookshot™ and your stack

Botpress is an open-source platform for building, deploying, and managing chatbots.

Browse integrations Visit website

Tools and triggers

What Agents can do in Botpress

Available tools and events after Botpress is connected.

  • BOTPRESS_CHARGE_WORKSPACE_UNPAID_INVOICES

    Tool to charge unpaid invoices for a specific Botpress workspace. Use when you need to manually trigger payment for outstanding workspace invoices. Returns details of successfully charged invoices and any that failed.

  • BOTPRESS_CREATE_ADMIN_INTEGRATION

    Tool to create a new integration in a Botpress workspace via the Admin API. Use when you need to provision a new integration with configuration including name, version, code, actions, events, and channels.

  • BOTPRESS_CREATE_ADMIN_WORKSPACE

    Tool to create a new workspace in Botpress via the Admin API. Use when you need to provision a new workspace for organizing bots and managing team resources. The workspace will be created under the authenticated…

  • BOTPRESS_CREATE_BOT

    Tool to create a new bot in a Botpress workspace via the Admin API. Use when you need to provision a new bot with optional configuration including name, code, tags, events, states, and integrations.

  • BOTPRESS_CREATE_CONVERSATION

    Tool to create a new conversation in Botpress via the Runtime API. Use when you need to initiate a new conversation thread. The required tags must be provided according to the specific integration being used.

  • BOTPRESS_RUN_VRL

    Tool to execute a VRL (Vector Remap Language) script against input data using the Botpress Admin API. Use when you need to transform or process data using VRL syntax. The script receives the input data and can perform…

  • BOTPRESS_SEND_MESSAGE

    Tool to send a message to an existing Botpress conversation via the Runtime API. Use when you need to create and deliver a message to a user.

  • BOTPRESS_UPDATE_ADMIN_BOTS

    Tool to update an existing bot in a Botpress workspace via the Admin API. Use when you need to modify bot configuration, update tags, change code, or adjust any other bot properties. Only the fields you provide will be…

  • BOTPRESS_UPDATE_WORKFLOW

    Tool to update a workflow object in Botpress by setting parameter values. Use when you need to change workflow status, add output data, update tags, or set failure reasons. Any parameters not provided will remain…

  • BOTPRESS_VALIDATE_INTEGRATION_UPDATE

    Tool to validate an integration update request in Botpress Admin API. Use when you need to verify that integration update parameters are valid before performing the actual update. Returns success if the integration can…

  • Break Down Workspace Usage by Bot

    Tool to break down workspace usage by bot. Use this to get detailed usage metrics for individual bots within a workspace, such as invocation calls, storage count, or AI spend.

  • Check Handle Availability

    Tool to check if a workspace handle is available in Botpress. Use when creating or renaming a workspace to verify the handle is not already taken. Returns availability status and suggestions for alternative handles if…

  • Delete Admin Workspace

    Tool to permanently delete a workspace from Botpress admin. Use this to remove workspaces that are no longer needed. The deletion is irreversible and removes all associated bots and data.

  • Delete File

    Permanently deletes a file from a Botpress bot's storage by its file ID. Use this tool to remove files that are no longer needed. The deletion is irreversible. Requires a valid file ID and the bot ID that owns the file.

  • Delete Integration Shareable ID

    Tool to delete a shareable ID for an integration installed in a Botpress bot. Use when you need to remove the human-readable identifier for a specific bot-integration crossover. This is an experimental feature used for…

  • Delete Knowledge Base

    Permanently deletes a knowledge base from Botpress by its knowledge base ID. Use this tool to remove knowledge bases that are no longer needed. The deletion is irreversible. Requires a valid knowledge base ID and the…

  • Get Account

    Tool to get details of the authenticated account. Use after confirming valid credentials.

  • Get Account Preference

    Tool to get a preference of the account. Use when you need to retrieve a specific account preference value by its key.

  • Get All Workspace Quota Completion

    Tool to get a map of workspace IDs to their highest quota completion rate. Use when monitoring workspace usage or checking quota limits across multiple workspaces.

  • Get Dereferenced Public Plugin by ID

    Tool to get a public plugin by ID with all interface entity references resolved to the corresponding entities as extended by the backing integrations. Use when you need to retrieve a plugin with its interfaces fully…

  • Get Integration

    Tool to get a specific Botpress integration by name and version. Use this to retrieve detailed information about an integration including its configuration, actions, events, channels, and metadata. Supports retrieving…

  • Get Public Integration

    Tool to retrieve a public integration by name and version from the Botpress hub. Use when you need to get integration details, check available actions/events/channels, or verify integration configuration.

  • Get Public Integration by ID

    Tool to retrieve detailed information about a public Botpress integration by its ID. Use when you need to fetch integration details including configuration, channels, actions, events, and metadata.

  • Get Public Interface

    Tool to get a public interface by name and version from the Botpress Hub. Use when you need to retrieve interface specifications, schemas, or metadata for integrations.

Setup

Connect Botpress in Hookshot™

Pick a scope, then confirm what can start a Protege and what it can do.

Trigger Access

What can start a Protege from this app.

Tool Access

What a Protege can do after it starts.

Connection scope

Prefer team for production.

Team

Shared credential for production and unattended runs.

Personal

Tied to one user—only when the workflow needs their account.

Chat

Team-scoped for supported chat surfaces.

Full setup guide

Build with us

See Hookshot™ in your stack.

Request early access or book a live walkthrough with the team.

Request Demo
Hookshot™ setup screen — AI agent workflow configuration with model selection, trigger status, and governance controls.