API Integration Guide

Integrate BuzzMyTable notifications into your POS system

Step 1: Create Order & Get QR Code URL

When a customer places an order, call our API to create an order record and receive a URL for QR code generation.

Endpoint:

POST https://api.buzzmytable.com/webhook/order/create

Py Python

import requests

url = "https://api.buzzmytable.com/webhook/order/create"
headers = {
    "Content-Type": "application/json",
    "x-api-key": "your-api-key-here"
}
data = {
    "posOrderId": "ORDER-123",
    "brandId": "your-brand-id",
    "venueId": "your-venue-id"  # Optional
}

response = requests.post(url, json=data, headers=headers)
result = response.json()

# Generate QR code URL
qr_url = f"https://buzzmytable.com/g/{result['orderId']}"
print(f"QR Code URL: {qr_url}")

TS TypeScript

interface OrderRequest {
  posOrderId: string;
  brandId: string;
  venueId?: string;
}

interface OrderResponse {
  orderId: string;
  posOrderId: string;
}

async function createOrder(orderData: OrderRequest): Promise {
  const response = await fetch('https://api.buzzmytable.com/webhook/order/create', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': 'your-api-key-here'
    },
    body: JSON.stringify(orderData)
  });
  
  const result: OrderResponse = await response.json();
  
  // Generate QR code URL
  const qrUrl = `https://buzzmytable.com/g/${result.orderId}`;
  return qrUrl;
}

// Usage
const qrUrl = await createOrder({
  posOrderId: 'ORDER-123',
  brandId: 'your-brand-id',
  venueId: 'your-venue-id'
});

$ cURL

curl -X POST https://api.buzzmytable.com/webhook/order/create \
  -H "Content-Type: application/json" \
  -H "x-api-key: your-api-key-here" \
  -d '{
    "posOrderId": "ORDER-123",
    "brandId": "your-brand-id",
    "venueId": "your-venue-id"
  }'

# Response:
# {
#   "orderId": "uuid-generated-id",
#   "posOrderId": "ORDER-123"
# }

# QR Code URL: https://buzzmytable.com/g/{orderId}

Step 2: Notify When Order is Ready

When the order is ready for pickup, call this endpoint to send push notifications to customers.

Endpoint:

POST https://api.buzzmytable.com/webhook/order/ready

Py Python

import requests

url = "https://api.buzzmytable.com/webhook/order/ready"
headers = {
    "Content-Type": "application/json",
    "x-api-key": "your-api-key-here"
}
data = {
    "orderId": "uuid-from-step-1"
}

response = requests.post(url, json=data, headers=headers)
print("Notification sent!", response.json())

TS TypeScript

async function notifyOrderReady(orderId: string): Promise {
  const response = await fetch('https://api.buzzmytable.com/webhook/order/ready', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': 'your-api-key-here'
    },
    body: JSON.stringify({ orderId })
  });
  
  const result = await response.json();
  console.log('Notification sent!', result);
}

// Usage
await notifyOrderReady('uuid-from-step-1');

$ cURL

curl -X POST https://api.buzzmytable.com/webhook/order/ready \
  -H "Content-Type: application/json" \
  -H "x-api-key: your-api-key-here" \
  -d '{
    "orderId": "uuid-from-step-1"
  }'

# Response:
# {
#   "success": true
# }

Getting Started

Sign up for an account

Create your BuzzMyTable account and get your API key

Configure your brand and venues

Set up your brand information and venue details in the dashboard

Integrate the API

Use the code examples above to integrate with your POS system

Generate QR codes

Print QR codes on receipts that link to the notification URLs

Get Started Now