Herbby API

API Reference

Welcome to the Herbby API. You can interact with our infrastructure through HTTP requests from any language, allowing you to programmatically send campaigns, sync contacts, and manage your workspace.

Authentication

Our API uses Bearer Token authentication to secure access to all endpoints. You must include a valid API key in every request to authenticate your identity and ensure authorized access to your workspace.

You can obtain an API key by navigating to the Developer & API section in your dashboard settings.

Security Note

Never expose API keys client-side. Treat them like passwords. Use backend environment variables or secret managers in production to store them.

Using the API Key

Include your API key in the Authorization header as a Bearer token:

Authorization: Bearer YOUR_API_KEY
curl -X GET https://api.herbby.digitechedge.com/api/user \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Using the Herbby Python SDK (Coming Soon)

Example of initializing the Herbby client in Python:

from herbby import HerbbyClient
import os

# Get API key from environment variable
api_key = os.getenv("HERBBY_API_KEY")

# Initialize client with API key
client = HerbbyClient(api_key=api_key)

# Fetch user profile
user = client.user.profile()
print(user)

Using the Herbby Node.js SDK (Coming Soon)

Example of initializing the Herbby client in Node.js:

const { HerbbyClient } = require("herbby-sdk");
require("dotenv").config();

async function init() {
    // Get API key from .env
    const apiKey = process.env.HERBBY_API_KEY;

    // Initialize client
    const herbby = new HerbbyClient({ apiKey });
    
    const user = await herbby.user.profile();
    console.log(user);
}

init();