> For the complete documentation index, see [llms.txt](https://docs.guestway.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.guestway.io/integrations/integrations.md).

# Integrations

Integrations connects Guestway to your PMS, OTAs, smart locks, thermostats and messaging services, and sets what each one syncs.

{% hint style="info" %}
**Requirements**

* You have the **Super admin** role, or a role with access to integrations.
* You work in an organization, not in a hub. In hub mode, the **Organization** settings are not shown.
  {% endhint %}

Go to **Settings** → **Organization** → **Integrations**.

## Integrations list

The page shows each integration of the organization as a card, with the logo, the name and the number of listings, smart locks, thermostats or **OTA Listings** it brings in. Click a card to open the integration.

* **Search...** finds integrations by their name or by the name of the product.
* **Create** opens the **Integration Wizard** to add an integration.
* When the organization has no integration yet, the wizard opens by itself.

A card can show these badges:

| Badge                   | Meaning                                                                         |
| ----------------------- | ------------------------------------------------------------------------------- |
| **Built-in**            | An integration that is part of Guestway.                                        |
| **Early Access**        | An integration that Guestway turns on for some organizations only.              |
| **Testing**             | An integration that is still being tested.                                      |
| **Inactive**            | The integration is paused. The card is grey.                                    |
| **Degraded**, **Down**  | The status of the connection to the other system.                               |
| **Credentials Expired** | The login of the integration is no longer valid. **Re-authenticate** renews it. |

## Integration wizard

**Create** opens the **Integration Wizard**. Its steps are:

| Step                 | What it does                                                                                                                                                                                                     |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Choose**           | Lists the integrations you can add, by category. Integrations in early access or testing are listed last, with their badge.                                                                                      |
| **Start**            | **Integration name** and the fields that the integration needs, for example the property ID. Then the ways to connect, under **Connect options**. The options are available once the required fields are filled. |
| **Connect**          | The login or the credentials of the other system.                                                                                                                                                                |
| **Email Forwarding** | The **Receiving email** and the **Forwarding email**. Only for Apaleo and Mews. **Skip for now** leaves it for later.                                                                                            |
| **Finish**           | **Success** and *Your integration is now connected.* For integrations through Seam.io, **Finalize** and *Syncing will begin shortly.*                                                                            |

* **Integration name** is required. It is the name of the product, followed by *Account* for a PMS or an OTA, for example *Hostaway Account*. You can change it later.
* **Go back** returns to the previous step.

### Categories

| Category                        | What it holds                                                                                                                                                                       |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Property Management Systems** | Your PMS. See [Property management systems](/integrations/property-management-systems.md).                                                                                          |
| **Channels & OTAs**             | Direct connections to Airbnb and Expedia. See [Channels and OTAs](/integrations/online-travel-agencies-ota.md).                                                                     |
| **Communication**               | SMS, WhatsApp, Instagram and Messenger. See [SMS](/integrations/sms.md), [WhatsApp](/integrations/whatsapp.md) and [How to connect Instagram and Messenger](/integrations/meta.md). |
| **Smart Locks**                 | Smart locks. See [Smart locks](/integrations/smart-locks.md).                                                                                                                       |
| **Climate**                     | Thermostats. See [Smart thermostats](/integrations/smart-thermostats.md).                                                                                                           |
| **More Integrations**           | Integrations that fit no other category.                                                                                                                                            |

A category shows only when it has integrations to add.

### Connect options

| Option                             | What you need                                                                      |
| ---------------------------------- | ---------------------------------------------------------------------------------- |
| **Login with Username & Password** | The username or email and the password of the other system.                        |
| **Access with API Key**            | An API key from the other system.                                                  |
| **Use Client ID & Secret**         | A client ID and a client secret from the other system.                             |
| **Secure Login via OAuth2**        | A login to the other system. Guestway sends you there to sign in and allow access. |
| **Secure Login via Seam.io**       | A login through the Seam.io portal.                                                |
| **No Credentials Required**        | Nothing. The integration needs no login.                                           |
| **WhatsApp Embedded Sign-Up**      | A Facebook login with access to your WhatsApp Business account.                    |
| **Sign in with Facebook**          | A Facebook login with admin access to your Facebook Page.                          |

The button that connects is **Authenticate**. With **No Credentials Required** it is **Connect**, and with the two Facebook options it is **Login with Facebook**. Each integration offers only its own options. The page of each integration says which one to use.

## Integration details

The details page shows three cards and the components of the integration. **Back to integrations** returns to the list.

### Information

The card shows the name, the status badge, the product, the date in **Created** and whether the integration is **Active** or **Paused**.

| Action              | What it does                                                                                                            |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **Re-authenticate** | Connects again with a new login or new credentials. The name and the fields stay.                                       |
| **Activate**        | Turns a paused integration on again, after you confirm with **Re-activate**. Shows only when the integration is paused. |
| **Delete**          | Removes the integration, after you confirm. For every integration except a PMS.                                         |
| **Purge**           | Removes a PMS integration. See below.                                                                                   |

**Purge** permanently removes all data linked to the PMS integration: its listings, reservations, guests and other records are marked as gone. To confirm, you must type the name of the integration. You cannot undo a purge.

Built-in integrations have no actions.

### Integration Configuration

The card shows **Integration name** and the fields of the integration. **Update** saves a change, after you confirm.

* The login and the credentials are not shown.
* Some fields cannot change after the integration is created. They show *This field has been set to read-only after creation.*

### OTA Messaging System

Only for Apaleo and Mews. These PMS do not send guest messages, so messages from Booking.com reach Guestway by email. See [How to connect Booking.com](/integrations/online-travel-agencies-ota/booking.com.md).

| Field                | What it does                                                                                      |
| -------------------- | ------------------------------------------------------------------------------------------------- |
| **Receiving email**  | The Guestway address that Booking.com sends its guest emails to. The copy button copies it.       |
| **Forwarding email** | An address of yours. Guestway forwards every email that arrives at the **Receiving email** to it. |

**Update** saves the forwarding email, after you confirm.

## Components

Below the cards, one tab for each kind of component that the integration brings in: listings, multi units, smart locks, thermostats, service templates and OTA listings. The number on a tab shows the subscribed components and the total.

| Tab                      | Columns                                                                                                             |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------- |
| Listings                 | **Listing**, **Complex**, **Listed**, **Subscribed**                                                                |
| Multi units              | **Nickname**, **Name**, **Complex**, **Listings**, **Subscribed**                                                   |
| Smart locks, thermostats | Status (**Online** or **Offline**), **Name**, **Subscribed**                                                        |
| Service templates        | **Name** (with the badge **Archived**), **Category**, **Type**, **Subscribed**                                      |
| OTA listings             | **Listing**, **Marketing Name**, **Listing Type**, **Property Type**, **Bedrooms**, **Bathrooms**, **Accommodates** |

**Subscribed** turns a component on in Guestway. When you turn it off, **Unsubscribe** asks you to confirm:

* All features of the component stop working.
* All settings of the component in Guestway are erased. If you subscribe it again, you set everything up again.
* When you unsubscribe a multi-unit, all its listings are unsubscribed as well.

**Don't remind me again** skips this question next time. OTA listings have no **Subscribed** column.

## Related

* [How to choose which listings and devices sync](/integrations/integrations/how-to-choose-which-listings-and-devices-sync.md)
* [Property management systems](/integrations/property-management-systems.md)
* [Channels and OTAs](/integrations/online-travel-agencies-ota.md)
* [Users and roles](/account-and-administration/users-and-roles.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.guestway.io/integrations/integrations.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
