API Documentation

// Create a new alert rule
const response = await fetch('https://api.serve-ai.com/v1/alerts', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Cash Drawer Variance Alert',
    type: 'variance',
    threshold: 50,
    frequency: 'immediate',
    channels: ['push', 'email'],
    conditions: {
      metric: 'cash_drawer_variance',
      operator: 'greater_than',
      value: 50
    }
  })
});

const alert = await response.json();

// Get all alerts with pagination
const response = await fetch('https://api.serve-ai.com/v1/alerts?page=1&limit=20', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data.alerts); // Array of alert objects
console.log(data.pagination); // Pagination details

// Configure a webhook endpoint
const response = await fetch('https://api.serve-ai.com/v1/webhooks', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://your-server.com/webhook',
    events: ['alert.triggered', 'alert.resolved'],
    secret: 'your-webhook-secret'
  })
});

// Resolve an alert
const response = await fetch('https://api.serve-ai.com/v1/alerts/alert_1234567890/resolve', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    resolution: 'Cash drawer discrepancy was due to incorrect change given. Staff retrained.',
    resolved_by: 'user_987654321',
    resolution_time: new Date().toISOString()
  })
});

const resolvedAlert = await response.json();

// Assign an alert to a group member
const response = await fetch('https://api.serve-ai.com/v1/alerts/alert_1234567890/assign', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    assignee_id: 'user_123456789',
    group_id: 'group_456789',
    priority: 'high',
    notes: 'Please investigate ASAP - multiple occurrences this week'
  })
});

const assignedAlert = await response.json();

// Create a new group
const response = await fetch('https://api.serve-ai.com/v1/groups', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Morning Shift Group',
    description: 'Handles operations from 6 AM to 2 PM',
    location_ids: ['loc_123', 'loc_456'],
    manager_id: 'user_789',
    members: [
      { user_id: 'user_111', role: 'shift_lead' },
      { user_id: 'user_222', role: 'cashier' },
      { user_id: 'user_333', role: 'server' }
    ],
    alert_preferences: {
      channels: ['push', 'email'],
      severity_levels: ['high', 'critical'],
      categories: ['cash_management', 'labor', 'compliance']
    }
  })
});

const group = await response.json();

// Create a new user
const response = await fetch('https://api.serve-ai.com/v1/users', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    email: 'john.doe@restaurant.com',
    name: 'John Doe',
    role: 'manager',
    department: 'operations',
    phone: '+1-555-0123',
    permissions: ['view_alerts', 'manage_alerts', 'view_reports'],
    notification_preferences: {
      channels: ['email', 'push'],
      alert_types: ['critical', 'high']
    }
  })
});

const user = await response.json();

// Get all users with filtering
const response = await fetch('https://api.serve-ai.com/v1/users?role=manager&department=operations', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data.users); // Array of user objects
console.log(data.pagination); // Pagination details