Br1gade API for your website and tools

For the web developer, quote-tool admin or Zapier builder at a restaurant or catering business that uses Br1gade.

Br1gade can take two things from your own systems: event requests (a catering quote or private-party booking from your website’s form, your quote tool or a Zapier flow) and job applications (from your careers page or an applicant tracking tool). Each lands in the business’s Br1gade for a manager to act on. Nothing is scheduled or hired automatically.

1. Get a key

An Owner or Manager makes a key in the Br1gade app: Schedule › Settings › API Keys › New Key. They choose a name (say, “Website form”) and what it may do, its scopes: event_requests (section 2), applications (section 3), availability (section 8), holds and events (sections 9 and 10, for a quote or booking tool that places real bookings). A key can also be pinned to one location; it then sees only that location. The key is shown once; copy it then. It looks like b1_live_ followed by 40 characters.

Keep it on your server or in your tool’s settings, never in a web page’s JavaScript. If it leaks, revoke it in the same place and make a new one; everything the old key sent stays, marked with that key.

Limits: 120 calls an hour per key, or 600 for a key with the availability scope (availability is meant to be polled). The count covers everything the key calls. Over that, you get 429 and the message to try again later.

2. Send an event request

POST https://api.br1gade.com/v1/events/request
Authorization: Bearer b1_live_...
Content-Type: application/json

{
  "request": {
    "contact_name": "Jane Doe",
    "contact_phone": "501-555-0123",
    "customer_email": "jane@example.com",
    "event_type": "WEDDING",
    "starts_at": "2026-11-14T22:00:00Z",
    "ends_at": "2026-11-15T03:00:00Z",
    "guest_count": 120,
    "remote": true,
    "address_line1": "12 Garden Lane",
    "city": "Little Rock",
    "state": "AR",
    "postal_code": "72201",
    "customer_notes": "Plated dinner, open bar until 11.",
    "location_id": null
  }
}

Event types: WEDDING, CORPORATE_MEETING, CONFERENCE, BIRTHDAY_PARTY, ANNIVERSARY, HOLIDAY_PARTY, FUNDRAISER, BABY_SHOWER, BRIDAL_SHOWER, GRADUATION, FUNERAL_MEMORIAL, RELIGIOUS_CELEBRATION, PRODUCT_LAUNCH_GRAND_OPENING, EMPLOYEE_APPRECIATION, TEAM_BUILDING, FESTIVAL, FAIR, SPORTING_EVENT, PRIVATE_DINNER_PARTY, COCKTAIL_PARTY, OTHER.

Response 200: { "success": true, "event_id": "…", "business_name": "Boars Nest" }. The request appears in the business’s Events as a request; the managers are notified.

3. Send a job application

POST https://api.br1gade.com/v1/jobs/apply
Authorization: Bearer b1_live_...
Content-Type: application/json

{
  "application": {
    "first_name": "Avery",
    "last_name": "Applicant",
    "email": "avery@example.com",
    "phone": "501-555-0166",
    "role": "SERVER",
    "hiring_need_id": null,
    "screening": [{ "position_question_id": "…", "answer": "Yes" }],
    "cover_note": "Three years at a wine bar.",
    "resume_url": "https://example.com/avery.pdf",
    "availability": { "weekends": true },
    "expected_wage": 18,
    "external_id": "your-system-id-123"
  }
}

Response 200: { "success": true, "application_id": "…", "hiring_need_id": "…", "status": "INTERVIEW", "duplicate": false }. The applicant appears in the business’s Hiring; the hiring managers are notified; the applicant gets a confirmation email, and an interview invitation when they passed the screening and the business invites automatically.

4. Hiring on your own website

Two ways, depending on who builds your site.

No developer: link your site’s “Careers” or “Jobs” button to your Br1gade careers page, https://br1gade.com/careers/<your-address>. It lists your open jobs, takes applications with your screening questions, and lets applicants book interviews. Turn it on in Br1gade: Schedule › Settings › Careers Page. To show the jobs on your own page without any coding, paste this where they should appear:

<div id="br1gade-jobs" data-business="<your-address>"></div>
<script src="https://br1gade.com/embed/jobs.js" async></script>

Each job links to its page on br1gade.com, where people apply. Options: data-heading="Join the team", data-empty="No openings right now", data-theme="dark"; the elements carry br1gade- classes you can style.

A developer, your own design: your site renders the jobs, takes the application and books the interview, and the applicant never leaves it. Three calls, no key needed for the reads:

The interview invitation and reminder emails carry the booking link. To send applicants to your own site instead of ours, set the booking address in Br1gade (Schedule › Settings › Hiring Automation › Interview booking page) to your page with {token} in it, for example https://yourvenue.com/interview?token={token}; your page then calls the two interview endpoints with that token. Emails to applicants are sent by Br1gade on your behalf either way.

If you build it yourself, a line such as “Hiring with Br1gade” linking to https://br1gade.com somewhere on the page is appreciated; it is not required.

5. Errors

Every refusal is JSON with success: false, an error code and a message you can show.

6. Zapier, Make, and web forms

Use a “Webhooks” or “HTTP request” step: method POST, the URL above, headers Authorization: Bearer b1_live_... and Content-Type: application/json, and a JSON body shaped as in section 2 or 3. For a plain HTML form on your site, post to your own server first and have it make the call: the key must not be in the page.

If you only want a form and have no developer, skip the API: turn on the hosted request page in Settings and link to https://br1gade.com/book/<your-address>.

7. Webhooks

Br1gade can call your server when something happens, so you do not have to poll. Owners and Managers add endpoints in the app under Settings > API Access > Webhooks (a Team feature, with the same 30-day trial as API keys): an https:// address, a label, and the events to send. Each endpoint gets a secret.

A delivery is a POST with Content-Type: application/json and these headers:

X-Br1gade-Event: application.status_changed
X-Br1gade-Delivery: 01a1…                      (unique per delivery; use it to ignore repeats)
X-Br1gade-Signature: sha256=<hex>              (HMAC-SHA256 of the exact request body, keyed with the endpoint's secret)

Verify the signature before trusting a delivery:

import { createHmac, timingSafeEqual } from "node:crypto";
const expected = "sha256=" + createHmac("sha256", process.env.BR1GADE_WEBHOOK_SECRET).update(rawBody).digest("hex");
const ok = timingSafeEqual(Buffer.from(expected), Buffer.from(req.headers["x-br1gade-signature"] ?? ""));

Answer with any 2xx within 10 seconds. Anything else is retried after 1 minute, 10 minutes, 1 hour and 6 hours, then marked failed; after 20 failures in a row the endpoint is switched off until you re-enable it in Settings, where the last ten deliveries and what your server answered are shown. “Send a test” sends a ping.

Three more types for a quote or booking tool (sections 8 to 10):

Your own API calls raise these too; ignore the echo by external_id and modified_at. Retries carry the same delivery_id, so store it and answer 200 to a repeat.

Body example:

{
  "event": "application.status_changed",
  "business_id": "…",
  "occurred_at": "2026-10-06T20:11:03Z",
  "delivery_id": "01a1…",
  "previous_status": "APPLIED",
  "application": { "id": "…", "status": "INTERVIEW", "hiring_need_id": "…", "role": "SERVER", "first_name": "Pat", "last_name": "Lee", "email": "pat@example.com", "phone": "+15015550100", "source": "API", "pre_screen_passed": true, "declined_reason": null, "interview_scheduled_at": null, "external_application_id": "your-id-123", "created_at": "…" }
}

8. Availability

Which days a location can take an event, for a quote or booking tool. Needs the availability scope.

GET https://api.br1gade.com/v1/availability?location_id=<uuid>&from=2027-05-01&to=2027-05-31
Authorization: Bearer b1_live_...

Response 200:

{
  "success": true,
  "location_id": "…",
  "timezone": "America/Chicago",
  "max_events_per_day": 1,
  "from": "2027-05-01",
  "to": "2027-05-31",
  "days": [
    { "date": "2027-05-01", "status": "OPEN", "events_count": 0, "holds_count": 0 },
    { "date": "2027-05-15", "status": "BOOKED", "events_count": 1, "holds_count": 0 }
  ]
}

A day is BOOKED when the location’s draft and posted events starting that day reach its events per day setting (Schedule › Settings › Events Per Day; max_events_per_day is null when the location has no cap, and then a day is never booked), HELD when a live hold exists on it (section 9), otherwise OPEN. A multi-day event counts on the day it starts. The answer carries Cache-Control: private, max-age=300; poll it no more than every few minutes.

9. Holds

A hold keeps a date while a quote is out. It makes the day HELD in section 8 and lets the booking in section 10 go through even if the day fills up meanwhile. Needs the holds scope.

POST https://api.br1gade.com/v1/holds
Authorization: Bearer b1_live_...
Content-Type: application/json

{
  "external_id": "quote_8841",
  "location_id": "…",
  "date": "2027-05-15",
  "expires_at": "2027-04-20T17:00:00Z",
  "note": "Smith wedding, 120 guests",
  "client": { "name": "Jane Smith", "phone": "501-555-0123", "email": "jane@example.com" }
}

Response 201 (or 200 when it already existed): { "success": true, "hold": { "id": "…", "external_id": "quote_8841", "location_id": "…", "date": "2027-05-15", "status": "ACTIVE", "expires_at": "…", "note": "…", "client": {…}, "converted_event_id": null, "created_at": "…", "modified_at": "…" } }. A hold on a day that is already BOOKED is refused with 409 CAPACITY_FULL. Holds never block other holds.

PATCH /v1/holds/<id> with { "expires_at": "…" } (and optionally note) extends an active hold. DELETE /v1/holds/<id> releases it (status: RELEASED; releasing twice is fine). A converted or expired hold answers 409 HOLD_NOT_ACTIVE. Statuses: ACTIVE, CONVERTED (an event was booked from it), RELEASED, EXPIRED.

10. Events

Book a paid quote as a real event, read it, change it, cancel it. Needs the events scope. The event lands as a draft for the manager, who adds staffing and posts it; nothing is scheduled by the API itself.

POST https://api.br1gade.com/v1/events
Authorization: Bearer b1_live_...
Content-Type: application/json

{
  "external_id": "quote_8841",
  "hold_id": "…",
  "location_id": "…",
  "name": "Smith wedding",
  "event_type": "WEDDING",
  "starts_at": "2027-05-15T22:00:00Z",
  "ends_at": "2027-05-16T03:00:00Z",
  "remote": true,
  "address_line1": "12 Garden Lane", "city": "Little Rock", "state": "AR", "postal_code": "72201", "country": "US",
  "guest_count": 120,
  "contact_name": "Jane Smith", "contact_phone": "501-555-0123", "customer_email": "jane@example.com",
  "customer_notes": "Plated dinner, open bar until 11.",
  "tier": "black_tie", "add_ons": ["champagne_toast"], "signature_drinks": ["Garden Spritz"], "named_problems": [],
  "quoted_price_cents": 250000,
  "needs": [{ "role": "BARTENDER", "headcount": 2 }, { "role": "SERVER", "headcount": 4, "start_at": "2027-05-15T21:00:00Z", "end_at": "2027-05-16T03:00:00Z" }]
}

Response 201 (or 200 for a repeat): { "success": true, "event": {…} } with the event object below. A day that is BOOKED and no live hold_id → 409 CAPACITY_FULL.

The event object (every answer and every event.* webhook):

{
  "id": "…", "external_id": "quote_8841", "business_id": "…", "location_id": "…", "hold_id": "…",
  "status": "DRAFT", "source": "API",
  "name": "Smith wedding", "event_type": "WEDDING", "starts_at": "…Z", "ends_at": "…Z",
  "remote": true, "address": { "line1": "12 Garden Lane", "line2": null, "city": "Little Rock", "state": "AR", "postal_code": "72201", "country": "US" },
  "guest_count": 120, "tier": "black_tie", "add_ons": ["champagne_toast"], "signature_drinks": ["Garden Spritz"], "named_problems": [],
  "contact_name": "Jane Smith", "contact_phone": "501-555-0123", "customer_email": "jane@example.com", "customer_notes": "…",
  "quoted_price_cents": 250000,
  "needs": [{ "id": "…", "role": "BARTENDER", "headcount": 2, "start_at": "…Z", "end_at": "…Z" }],
  "crew_assigned": 0,
  "actuals": null, "closed_at": null, "cancel_reason": null, "posted_at": null,
  "created_at": "…", "modified_at": "…"
}

status is DRAFT (waiting for the manager), POSTED (staffed and on the schedule), COMPLETED (closed with actuals, section 11) or CANCELLED. crew_assigned is how many shifts have a person on them. No names, timesheets or checklists ever leave Br1gade.

11. Closing an event

When the event has ended, an Owner or Manager closes it in the app (the event › Close event) with the actuals: hours worked, bartenders, add-ons that were served, leftover count, and whether there was an incident. Hours and bartenders are prefilled from the clock-ins on the event’s shifts. The event becomes COMPLETED and event.closed goes out with:

"actuals": { "hours_actual": 11.5, "bartenders_actual": 2, "add_ons_actual": ["champagne_toast"], "leftover_count": 3, "incident_report": false, "closed_at": "…Z" }

A closed event cannot be changed or cancelled through the API (409 EVENT_COMPLETED). Who worked, their timesheets and checklists stay in Br1gade.