> ## Documentation Index
> Fetch the complete documentation index at: https://docs.famulor.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Hostaway

> Let your assistant recognise guests and answer questions about their stay from Hostaway.

Let your assistant recognise guests, answer questions about their stay and share check-in details from your Hostaway account. The connection only reads: nothing in Hostaway is created, changed or cancelled.

For example, a guest calls at 10 pm: "I'm standing at the door, what's the door code?" The assistant finds the booking, checks that it is confirmed and that the stay starts tomorrow or is running, and reads the code slowly.

## Set up your account

1. In Hostaway, open **Settings → Hostaway API** and choose **Create**. Pick any name and the partner **Hostaway Public API**. Hostaway shows the **Account ID** and the **API key** once, so copy both before you close the window.
2. Open **Agent Tools → Marketplace → Hostaway**. Enter the account ID and the API key.
3. Choose **Add**. The sign-in is checked before the connection is saved, and the account needs at least one property. Then assign the connection to your assistant.

> [!WARNING]
>
> Hostaway keys always have full access to the account, and you can't limit them to read-only. This connection only reads, but keep the key private and revoke it in Hostaway if it leaks.

To change the account or the key later, remove the tool and connect again.

## What the assistant can do

Enabled by default:

* **Property information**: address, check-in and check-out times in local time, house rules, capacity and amenities. Wi-Fi, door codes and owner contact details are not part of it.
* **Find reservation**: finds a guest's current or upcoming reservation by last name and booking code (the Airbnb or Booking.com confirmation code, another channel's code or the Hostaway reservation number).
* **Reservation details**: status, dates, check-in and check-out times of the caller's own reservation.
* **Share Wi-Fi** and **Share door codes**: see below.

Optional, choose it under **Edit**:

* **Availability and price**: checks whether a property is free for given dates and quotes the price. It is a quote, never a booking.

> [!WARNING]
>
> House rules are read to every caller. Keep Wi-Fi passwords and key-box codes in the Wi-Fi and door-code fields in Hostaway, not in the house rules.

## Recognising callers

Before the greeting, Famulor compares the caller's number with the stays that are running or start within the next 30 days. A single match gives the assistant the guest's first name, the property, the dates, the check-in times and the booking status as variables starting with `hostaway_`, so it can greet the guest by name. See [Variables](https://docs.famulor.io/assistants/variables.md).

If the number belongs to several stays, is shared by other guests or is not in Hostaway, the assistant asks for the last name and the booking code and uses **Find reservation**. Withheld numbers work the same way. In the conversation, **Reservation details** finds the stay by the caller's number too.

## Door codes and Wi-Fi

The assistant shares these details only for confirmed bookings, from the day before arrival to the departure day, in the time zone of the property. Inquiries, owner stays and cancelled bookings never get them. A guest who calls earlier hears from which day they are available.

* **Wi-Fi** is available when the caller's number matches exactly one stay, or after the last name and the booking code.
* The **door code**, key handover and arrival instructions need the last name and the booking code as well. After three wrong tries in a conversation, the assistant stops checking. Every failed check gets the same answer, so nobody learns whether a booking exists.

You switch either one off under **Edit** with the tools **Share door codes** and **Share Wi-Fi**. Both are on by default.

## What stays unchanged in Hostaway

Nothing is created, changed or cancelled, and no message is sent to a guest. The assistant reads bookings, properties and prices.

## Test safely

Create a test reservation in Hostaway and ask the assistant for it with the last name and the booking code (**Find reservation**). A real conversation reads real codes, so use a test property or a booking that is allowed to get them.

## Channels

On the phone the assistant works with the number it is called from. In web chat there is no number, so it asks for the last name and the booking code. WhatsApp and SMS recognise guests by their phone number. In email, the verified sender address is used.

## Automations

Connect **Hostaway** under **Automations → Connections**, or import its Agent Tool connection. Every tool is available as an action: **Property information**, **Find reservation**, **Reservation details**, **Share Wi-Fi**, **Share door codes** and **Availability and price**. An automation started by a call or a text conversation (SMS, WhatsApp) knows the other party's number from that call itself. Other runs (webhook, schedule) have no caller, so **Reservation details** and **Share Wi-Fi** need a **Reservation reference** from a previous **Find reservation** step there.

## API, MCP, CLI & SDK

`POST /api/v1/tools/integrations/hostaway` · MCP `connect_integration` · CLI `famulor connect-integration hostaway`.

`client.api.connectIntegration` needs `famulor-sdk` 0.2.12 or later. Update the CLI with `npm install --global famulor` before you use `connect-integration`.

```bash theme={null}
famulor connect-integration hostaway --fields '{"account_id":"12345","api_key":"'"$HOSTAWAY_API_KEY"'"}' --name hostaway
```

```typescript theme={null}
import { Famulor } from 'famulor-sdk';

const client = new Famulor({ apiKey: process.env.FAMULOR_API_KEY });
const { data: tool } = await client.api.connectIntegration({
  path: { provider: 'hostaway' },
  body: {
    fields: { account_id: '12345', api_key: process.env.HOSTAWAY_API_KEY },
    name: 'hostaway',
  },
});
console.log(tool.id);
```

## Limits

* Hostaway limits requests per account and per IP address. The limit is shared with your other Hostaway integrations, so a busy period elsewhere can slow the assistant down.
* Accounts with more than 300 stays in the next 30 days may not be recognised before the greeting. Above 500 stays the caller's number is not enough in the conversation either. The assistant then asks for the last name and the booking code.
* Prices are in the currency of the property.
* Hostaway keys and tokens expire after 24 months. Create a new key and connect again when the connection stops working.

[Hostaway API documentation](https://api.hostaway.com/documentation)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.