Skip to main content
The Sherpa provider integrates BuilderBot with the Sherpa messaging platform, enabling multi-channel communication capabilities.

Features

  • Multi-channel messaging
  • Text and media support
  • Webhook integration
  • API-based communication
  • Message tracking
  • Delivery reports

Installation

npm install @builderbot/bot @builderbot/provider-sherpa

Configuration

Basic Setup

import { createBot, createProvider, createFlow } from '@builderbot/bot'
import { SherpaProvider } from '@builderbot/provider-sherpa'
import { MemoryDB } from '@builderbot/bot'

const provider = createProvider(SherpaProvider, {
  apiKey: 'YOUR_API_KEY',
  apiUrl: 'https://api.sherpa.com',
  port: 3000
})

const { handleCtx, httpServer } = await createBot({
  flow: adapterFlow,
  provider: provider,
  database: new MemoryDB(),
})

httpServer(3000)

Environment Variables

SHERPA_API_KEY=your_api_key
SHERPA_API_URL=https://api.sherpa.com
PORT=3000

Basic Usage

Sending Messages

import { addKeyword } from '@builderbot/bot'

const welcomeFlow = addKeyword(['hi', 'hello'])
  .addAnswer('Hello! Welcome to Sherpa')
  .addAnswer('How can we help?')

Sending Media

const mediaFlow = addKeyword('media')
  .addAnswer('Here is your file:', {
    media: 'https://example.com/file.pdf'
  })

Webhook Configuration

POST /webhook - Receive messages

Further Resources

Build docs developers (and LLMs) love