Skip to content

Connect other apps — API and webhooks

Your other apps can work with BiteTheMenu. A sheet, a kitchen screen or an automation tool can read your venue. It can also hear about a new order the moment it comes in.

The rule

Your apps can do only what your key allows. A change always waits for a person to approve it.

How it works

There are two parts. Both are on AI → API & connectors, in the For developers tab.

  1. The API. Make a key in the Keys tab. Your other app uses this key. It asks for data, for example your menu, and gets it back. The Connect other apps card shows the address and an example.
  2. Webhooks. Press Add a webhook. Type your app’s address and pick the events, for example New order. Copy the signing secret. It is shown only once.
  3. Press Send test to check that your app gets the message. Latest messages shows if each one arrived.

Good to know

  • On the Essential and Plus plans. On a lower plan, your keys and webhooks are kept, but they do not work. They work again when you move up.
  • Use a venue key for an app. An owner can make a key that acts as a role, like The venue, as Manager. It does not stop when the person who made it leaves.
  • Use the API from a server, never from a web page. Anyone can read a key in a web page.
  • The same limits. A key can make 30 calls a minute and 1,000 a day. The API and your AI agent share them.
  • A message has the details as separate fields. A booking request has the date, the number of people and the guest’s email. Your app does not need to read the text.
  • You can make a new secret. Press New secret on the webhook. For 24 hours, each message is signed with the new secret and the old one. Your app can change to the new one in that time. Press Stop the old secret now if the old secret is lost or stolen.
  • Each message is signed. Your app checks the signature with the secret, so it knows the message came from us.
  • We try again. When your app does not answer, we try 5 more times over about 10 hours. After 10 failed messages in a row, the webhook turns off. Press Turn on when your app is fixed.
  • Guest details stay protected. Only owners and managers can send events with a guest’s name and phone, like a booking request.
  • Your own AI agent — the keys, their permissions and their limits.
  • Telegram — the same events, sent to people instead of apps.