# Hostaway

Each new Hostaway reservation sends the guest the agreement and waivers that listing needs, re-read from Hostaway so what they sign matches the booking.

> **Beta.** Built against Hostaway's published Public API and tested against it on our side, not yet with a live Hostaway account. It needs no partnership: the key is one you create. Listing on the Hostaway Marketplace is a separate certification we have not started. Links go by email. They go by text only to a guest whose consent to receive texts from you is on file in SignSealer: a booking system knowing a phone number is not that guest agreeing to be texted, and SignSealer never treats it as if it were. Texts go from your business's own number, which is coming soon.

## Before you start

- The membership: connecting a booking system comes with it ([how that works](https://signsealer.com/docs/integrations)). On Free, your 10 signings a month are sent from the dashboard.
- A SignSealer account with the terms signed and a published form for each document.
- Access to Hostaway's settings, to create an API key.
- Once it is connected, documents chosen on its page for what each listing's bookings need.

## Connect Hostaway

1. In Hostaway, open **Settings → Hostaway API** and press **Create**. Choose **Hostaway Public API** as the partner. Copy your **account ID** and the **API key**.
2. In SignSealer, open [Integrations](https://app.signsealer.com/integrations), choose **Hostaway → Connect**, and paste both.
3. Choose the settings and press **Connect Hostaway**. SignSealer exchanges the key for a token (proving it) and registers a unified webhook with a login and password it made for this connection.
4. Make a test reservation in Hostaway and watch it arrive under the connection's activity.

## What SignSealer sets up in Hostaway

One unified webhook (`POST /v1/webhooks/unifiedWebhooks`) pointing at this connection's delivery address, with a Basic Auth login and password generated for it. Hostaway sends reservation created, reservation updated and new-message events to it; messages are accepted and ignored.

## What comes across

| Hostaway | In SignSealer | Notes |
| --- | --- | --- |
| **id** | Reservation external ID |  |
| **listingName, channelReservationId** | Label |  |
| **arrivalDate / departureDate** | Starts on / ends on |  |
| **guestFirstName + guestLastName, guestEmail, phone** | Primary guest | Recognized on update by the Hostaway guest ID |
| **numberOfGuests, adults, children, pets** | Facts: guests, adults, minors, pets |  |
| **channelName or source** | Fact: channel |  |
| **listingMapId** | Facts: property, property_name |  |
| **status** | What happens | new, modified: worked · inquiry, pending, owner stays: ignored · canceled, declined, expired: canceled |

## Documents that read it

The reservation carries these facts, which a document's *Only bookings where* can read: `guests`, `adults`, `minors`, `pets`, `channel`, `property` and `property_name`. For example, a waiver for every adult on stays with more than six guests is *Each adult*, *Only bookings where* guests *is more than* 6.

Documents are chosen under **Documents for bookings** on the connection's page in [Integrations](https://app.signsealer.com/integrations) (there is no API route for them yet); see [Reservations and packets](https://signsealer.com/docs/packets).

## How a delivery is proven

Hostaway does not sign its webhooks. SignSealer registers the webhook with a login and password of its own and refuses any delivery without them (compared in constant time), at an address whose 64-character token is itself a secret. Neither proves the delivery's contents, so the delivery is used only to learn which reservation changed, and the reservation is always read back from Hostaway's API. A forged delivery can at most make SignSealer re-read one of your own reservations. Hostaway also delivers from fixed addresses; SignSealer does not rely on them.

## Settings

| Setting | Choices | What it does |
| --- | --- | --- |
| **When a booking arrives** | Send straight away (default) · Build the list and wait | Straight away starts everything the packet owes as soon as the booking is worked. Waiting builds the reservation and its packet and sends nothing until somebody presses Send on the reservation, or your code calls `POST /v1/packets/{id}/start`. |
| **When a booking is canceled** | Void what nobody has signed (default) · Leave it | Voiding marks every unfinished document with the reason and the packet void. Anything already signed is kept: an executed waiver is evidence of what was agreed. |

What each guest is sent is decided by the connection's **documents for bookings**, chosen on its page: each says which document, who signs it — the person who booked, every adult, or a parent or guardian for each minor — and which bookings, read from the reservation's facts (dates, guest counts, property, channel). A default covers the bookings nothing else fits, and a booking that matched nothing says so in the connection's activity ([Reservations and packets](https://signsealer.com/docs/packets)).

## Texting and consent

Signing links go by email. They also go by text only when SignSealer holds that guest's consent to receive texts from your business, recorded with the exact words they agreed to — at your counter, on your booking form through `POST /v1/sms-consents`, or on SignSealer's own opt-in. That check runs when the link is queued (`app.may_text`), not in the integration.

No booking system can give SignSealer that consent, so none is treated as if it could. Each adapter records what the provider's data said — `VERIFIED_CONSENT`, `NO_CONSENT` or `INSUFFICIENT_EVIDENCE` — and only `NO_CONSENT` changes anything: the guest's number is not written at all. Every provider built so far can only ever say `INSUFFICIENT_EVIDENCE`. The connection's activity shows, for each guest with a number, whether the link was also texted and why not.

[How to record consent you took yourself](https://signsealer.com/docs/texting).

## Duplicates, order and retries

- **Once.** A delivery is recorded once per connection and event id. A provider that redelivers the same event gets `200 {"duplicate": true}` and nothing happens twice.
- **Newest wins.** Each event means "read this booking as it is now". A newer event about a booking supersedes an older one still waiting, and one booking is never worked twice at once.
- **Nothing is sent twice.** Guests are recognized by their id in the provider (or by address and name), so an update keeps each guest's link to what they were already sent.
- **Retries.** A failure is retried after 1, 2, 4, 8 … minutes, up to six hours apart, and gives up after eight tries. It is then listed, with its reason, under the connection's activity, where it can be tried again once whatever refused it is fixed.
- **The reason is in our words.** What the activity says of a failure is one plain sentence about what happened and what to do: the provider refused our credentials, did not answer, is limiting us, answered with an error, or says the booking or listing does not exist. It carries the provider's status code where there is one, such as `(422)`, and a short reference to quote if you write to us. What the provider itself wrote back is not kept or shown, because it can quote a guest's name, email or phone.
- **Refused credentials.** If the provider refuses SignSealer's credentials, the connection goes to *needs attention* and stops working events until new credentials are given. What arrives meanwhile is kept and worked afterwards.
- **Retention.** What arrived is cleared thirty days after it was worked; the outcome and the reservation it made are kept.

## Troubleshooting

| What you see | Why | What to do |
| --- | --- | --- |
| **“Hostaway refused our credentials”** | The account ID or key is wrong, or the key was deleted | Create a new key for Hostaway Public API and paste it |
| **Needs attention after it worked** | The key was revoked in Hostaway | Paste a new key on the connection's page |
| **Deliveries show 401 in Hostaway** | The webhook was edited in Hostaway and lost SignSealer's login | Press New address; SignSealer registers a fresh webhook with a new login |
| **A guest got nothing** | No email on the reservation, or no document fits the booking | The activity names the guest and the reason, or says nothing fitted |

## Hostaway's limits

Hostaway allows 200 requests per 10 seconds per account; SignSealer makes one read per reservation change and keeps its token, which Hostaway issues for months, sealed. Hostaway retries a delivery up to three times within about an hour, only after a network error, a 5xx or a 429, and treats other 4xx answers as final; SignSealer answers 200 as soon as a delivery is recorded.

## Pausing and disconnecting

**Pause** keeps recording what arrives and works nothing until you resume. **New address** stops the old delivery address at once (and re-registers the webhook with the provider where SignSealer set it up). **Disconnect** revokes the connection's key, clears its credentials, removes the webhook from the provider where it can, and closes the address. The reservations and documents it made stay, with where they came from.

## From your own code

```
curl https://api.signsealer.com/v1/integrations -H "Authorization: Bearer $KEY"
curl https://api.signsealer.com/v1/integrations/$CONNECTION/events -H "Authorization: Bearer $KEY"
```

The first lists every provider with its status and your connections with their state; the second is what arrived from one connection and what became of it. Neither ever returns a credential, a delivery address or what arrived. Both need the `signing:read` scope. Connecting happens in the dashboard, where the provider confirms the credentials. See the [API reference](https://signsealer.com/docs/api).

[This page as Markdown](https://signsealer.com/docs/integrations/hostaway.md) Ask an AI about it: [ChatGPT](https://chatgpt.com/?q=Please%20read%20https%3A%2F%2Fsignsealer.com%2Fdocs%2Fintegrations%2Fhostaway%20and%20explain%20it%20to%20me%20as%20a%20developer%20adding%20SignSealer%20to%20my%20application%3A%20what%20it%20covers%2C%20the%20calls%20involved%20and%20anything%20to%20watch%20out%20for.%20Use%20https%3A%2F%2Fsignsealer.com%2Fllms.txt%20for%20the%20rest%20of%20the%20docs%2C%20and%20cite%20the%20page%27s%20URL%20in%20your%20answer.) · [Claude](https://claude.ai/new?q=Please%20read%20https%3A%2F%2Fsignsealer.com%2Fdocs%2Fintegrations%2Fhostaway%20and%20explain%20it%20to%20me%20as%20a%20developer%20adding%20SignSealer%20to%20my%20application%3A%20what%20it%20covers%2C%20the%20calls%20involved%20and%20anything%20to%20watch%20out%20for.%20Use%20https%3A%2F%2Fsignsealer.com%2Fllms.txt%20for%20the%20rest%20of%20the%20docs%2C%20and%20cite%20the%20page%27s%20URL%20in%20your%20answer.) · [Perplexity](https://www.perplexity.ai/search?q=Please%20read%20https%3A%2F%2Fsignsealer.com%2Fdocs%2Fintegrations%2Fhostaway%20and%20explain%20it%20to%20me%20as%20a%20developer%20adding%20SignSealer%20to%20my%20application%3A%20what%20it%20covers%2C%20the%20calls%20involved%20and%20anything%20to%20watch%20out%20for.%20Use%20https%3A%2F%2Fsignsealer.com%2Fllms.txt%20for%20the%20rest%20of%20the%20docs%2C%20and%20cite%20the%20page%27s%20URL%20in%20your%20answer.) · [Google AI](https://www.google.com/search?udm=50&q=Please%20read%20https%3A%2F%2Fsignsealer.com%2Fdocs%2Fintegrations%2Fhostaway%20and%20explain%20it%20to%20me%20as%20a%20developer%20adding%20SignSealer%20to%20my%20application%3A%20what%20it%20covers%2C%20the%20calls%20involved%20and%20anything%20to%20watch%20out%20for.%20Use%20https%3A%2F%2Fsignsealer.com%2Fllms.txt%20for%20the%20rest%20of%20the%20docs%2C%20and%20cite%20the%20page%27s%20URL%20in%20your%20answer.) · [Grok](https://grok.com/?q=Please%20read%20https%3A%2F%2Fsignsealer.com%2Fdocs%2Fintegrations%2Fhostaway%20and%20explain%20it%20to%20me%20as%20a%20developer%20adding%20SignSealer%20to%20my%20application%3A%20what%20it%20covers%2C%20the%20calls%20involved%20and%20anything%20to%20watch%20out%20for.%20Use%20https%3A%2F%2Fsignsealer.com%2Fllms.txt%20for%20the%20rest%20of%20the%20docs%2C%20and%20cite%20the%20page%27s%20URL%20in%20your%20answer.)
