API & Integrations

Unlocking BarBud for Developers

BarBud is designed as a platform, not just an app. With our REST API and Webhooks, you can integrate your inventory, sales, and customer data with CRMs, booking engines, or custom websites.

1. Generating API Keys

To authenticate with the BarBud API, you need a scoped API key tied to your tenant (bar).

1. Go to Settings → Developer Hub.
2. Click Generate New API Key.
3. Give it a descriptive name (e.g., "Website Menu Sync").
4. Select the necessary scopes (e.g., inventory:read, tabs:write).
5. Copy the generated key immediately; it will not be shown again.

2. Making API Requests

All API calls must be made over HTTPS to /api/v1/.... Include your API key in the Authorization header as a Bearer token.

fetch('https://your-barbud-domain.com/api/v1/inventory/items', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY_HERE'
  }
})

You can find the full interactive API documentation by visiting API Reference.

3. Webhooks

Instead of polling the API, set up webhooks to receive real-time notifications when events happen in BarBud.

• Inventory Alerts: Subscribe to inventory.low_stock to notify your ordering system automatically.
• Sales & Tabs: Use tab.closed to trigger loyalty emails or update a live dashboard.
• Staff Shifts: Track shift.started and shift.ended in your payroll software.

Manage your webhook subscriptions in the Developer Hub under Settings. Each webhook request includes a signature header for verification.