Create Reservation with Hostaway API

Pipedream makes it easy to connect APIs for Hostaway and 2,800+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Reservation with the Hostaway API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Reservation with the Hostaway API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Reservation action
1. Connect your Hostaway account
2. Select a Channel
3. Select a Listing
4. Configure Arrival Date
5. Configure Departure Date
6. Optional- Configure Guest Name
7. Optional- Configure Guest Email
8. Optional- Configure Number of Guests
9. Optional- Configure Additional Fields
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Reservation with Hostaway API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Hostaway

Try it

Create Reservation with Hostaway API on New Submission from Typeform API

Typeform + Hostaway

Try it

Create Reservation with Hostaway API on New Submission (Instant) from Jotform API

Jotform + Hostaway

Try it

Create Reservation with Hostaway API on New Scheduled Tasks from Pipedream API

Pipedream + Hostaway

Try it

Create Reservation with Hostaway API on New Download Counts from npm API

npm + Hostaway

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Reservation on Hostaway

Description:Creates a new reservation in Hostaway. [See the documentation](https://api.hostaway.com/documentation#create-a-reservation)

Version:0.0.2

Key:hostaway-create-reservation

View on GitHub

Code#

import hostaway from "../../hostaway.app.mjs";

export default {
  key: "hostaway-create-reservation",
  name: "Create Reservation",
  description: "Creates a new reservation in Hostaway. [See the documentation](https://api.hostaway.com/documentation#create-a-reservation)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    hostaway,
    channelId: {
      propDefinition: [
        hostaway,
        "channelId",
      ],
    },
    listingMapId: {
      propDefinition: [
        hostaway,
        "listingId",
      ],
    },
    arrivalDate: {
      type: "string",
      label: "Arrival Date",
      description: "Arrival date in `YYYY-MM-DD` format, e.g. `2024-08-15`",
    },
    departureDate: {
      type: "string",
      label: "Departure Date",
      description: "Departure date in `YYYY-MM-DD` format, e.g. `2024-08-19`",
    },
    guestName: {
      type: "string",
      label: "Guest Name",
      description: "Name of the guest",
      optional: true,
    },
    guestEmail: {
      type: "string",
      label: "Guest Email",
      description: "Email address of the guest",
      optional: true,
    },
    numberOfGuests: {
      type: "integer",
      label: "Number of Guests",
      description: "Number of guests for the reservation",
      optional: true,
    },
    additionalFields: {
      type: "object",
      label: "Additional Fields",
      description: "Additional fields to set for the reservation. [See the documentation](https://api.hostaway.com/documentation#reservation-object) for all available fields.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      hostaway, additionalFields = {}, ...data
    } = this;
    const { result } = await hostaway.createReservation({
      $,
      data: {
        ...data,
        ...additionalFields,
      },
    });

    if (result?.id) {
      $.export("summary", `Successfully created reservation (ID: ${result.id})`);
    }

    return result;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Hostaway	`hostaway`	`app`	This component uses the Hostaway app.
Channel	`channelId`	`integer`	Select a value from the drop down menu:`{ "value": 2018, "label": "airbnbOfficial" }{ "value": 2002, "label": "homeaway" }{ "value": 2005, "label": "bookingcom" }{ "value": 2007, "label": "expedia" }{ "value": 2009, "label": "homeawayical" }{ "value": 2010, "label": "vrboical" }{ "value": 2000, "label": "direct" }{ "value": 2013, "label": "bookingengine" }{ "value": 2015, "label": "customIcal" }{ "value": 2016, "label": "tripadvisorical" }{ "value": 2017, "label": "wordpress" }{ "value": 2019, "label": "marriott" }{ "value": 2020, "label": "partner" }{ "value": 2021, "label": "gds" }{ "value": 2022, "label": "google" }`
Listing	`listingMapId`	`string`	Select a value from the drop down menu.
Arrival Date	`arrivalDate`	`string`	Arrival date in `YYYY-MM-DD` format, e.g. `2024-08-15`
Departure Date	`departureDate`	`string`	Departure date in `YYYY-MM-DD` format, e.g. `2024-08-19`
Guest Name	`guestName`	`string`	Name of the guest
Guest Email	`guestEmail`	`string`	Email address of the guest
Number of Guests	`numberOfGuests`	`integer`	Number of guests for the reservation
Additional Fields	`additionalFields`	`object`	Additional fields to set for the reservation. See the documentation for all available fields.

Authentication#

Hostaway uses OAuth authentication. When you connect your Hostaway account, Pipedream will open a popup window where you can sign into Hostaway and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Hostaway API.

Pipedream requests the following authorization scopes when you connect your account: