Overview
Ten things people build on the WeerOm API, each with the key it needs, the steps, a code sketch and what the API cannot do for it.
Each use case names who it is for, the endpoints and the kind of key, the steps, a short sketch in JavaScript, and its limits. The sketches call only real WeerOm endpoints and fields. Where another product comes in, a named function such as createBillitInvoice(payment) stands for your own code, which you write from that product's documentation.
- 01Send payments to BillitMake one invoice in Billit for every payment staff note in WeerOm.Read key
- 02Bookkeeping with AccountableBuild the admin's Accountable lines from the payments: one per day and payment method.Read key
- 03Your own booking pageYour own design on any site, with WeerOm's agenda, rules and mail behind it.Public keyWrite key
- 04Bookings in your calendarCopy every booking into Google Calendar or Outlook and keep the copy current.Read key
- 05Customers in a mailing toolKeep a Mailchimp or Brevo list in step with the shop's customers.Read key
- 06A revenue sheetRevenue per day, per staff member and per payment method in Google Sheets.Read key
- 07AutomationsA flow in n8n, Make or Zapier, started by a WeerOm webhook or on a schedule.Read keyWrite key
- 08Messages by SMS or WhatsAppSend tomorrow's customers a text or a WhatsApp message through your own provider.Read key
- 09An assistant that booksA chat or phone assistant that finds free times and books them from your server.Write key
- 10Several shops on one screenOne key for each shop and one loop, for an owner with two shops or a group.Read key
The kinds of key
| Key | Starts with | Use it for |
|---|---|---|
| Read key | wo_live_ | A server that reads: invoices, bookkeeping, calendars, sheets, dashboards. |
| Write key | wo_live_ | A server that also books, cancels, moves or blocks. |
| Public key | wo_pub_ | A booking page in the browser. |
Authentication says what each may do and how a shop makes one.
Following changes
A use case that follows changes can hear about them in two ways.
- Webhooks. WeerOm posts a signed message to your server a few seconds after a booking is made, changed or cancelled, or a payment is noted. The invoices, the calendar, the reminders and the automations use them. See Webhooks.
- Polling. A job asks on a schedule, with
updated_afteron bookings and customers orpaid_afteron payments. One run that finds nothing costs one request. At 120 requests a minute for each key, a job every 5 or 15 minutes uses a small part of it. Customers send no webhook, so the newsletter polls. The revenue sheet polls because once an hour is enough.
Where both fit, each page says which to pick.