Create a Subscription with Pipedream API on New Message Received from Hostaway API

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

Trigger workflow on

New Message Received from the Hostaway API

Next, do this

Create a Subscription with the Pipedream 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#

This integration creates a workflow with a Hostaway trigger and Pipedream action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Message Received trigger
1. Connect your Hostaway account
Configure the Create a Subscription action
1. Connect your Pipedream account
2. Select a Subscription category
3. Select a Subscription source
4. Optional- Select a Event name
5. Configure Listener ID
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Message Received on Hostaway

Description:Emit new event when a new message is received in Hostaway.

Version:0.0.3

Key:hostaway-new-message-received

View on GitHub

Hostaway Overview#

The Hostaway API allows for automation and integration with their property management platform. It provides endpoints for managing listings, bookings, messages, and more. On Pipedream, you can leverage these endpoints to create automated workflows that connect Hostaway with various other services, such as calendars, email, and messaging apps, or even custom functions for enhanced property management. Whether you're aiming to synchronize booking calendars or automate guest communication, the Hostaway API on Pipedream enables you to streamline operations and enhance guest experiences with ease.

Trigger Code#

import common from "../common/common.mjs";

export default {
  ...common,
  key: "hostaway-new-message-received",
  name: "New Message Received",
  description: "Emit new event when a new message is received in Hostaway.",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    isRelevant(eventType) {
      return eventType === "message.received";
    },
    generateMeta(message) {
      return {
        id: message.id,
        summary: `New Message - ${message.id}`,
        ts: Date.parse(message.insertedOn),
      };
    },
  },
};

Trigger 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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

Trigger 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:

About Hostaway#

More bookings, more revenue, less hassle for your rentals with Hostaway.

Action#

Create a Subscription on Pipedream

Description:Create a Subscription. [See Doc](https://pipedream.com/docs/api/rest/#subscriptions)

Version:0.1.0

Key:pipedream-create-subscription

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Action Code#

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

export default {
  key: "pipedream-create-subscription",
  name: "Create a Subscription",
  description: "Create a Subscription. [See Doc](https://pipedream.com/docs/api/rest/#subscriptions)",
  version: "0.1.0",
  type: "action",
  props: {
    pipedream,
    subscriptionCategory: {
      propDefinition: [
        pipedream,
        "subscriptionCategory",
      ],
    },
    subscriptionSource: {
      propDefinition: [
        pipedream,
        "subscriptionSource",
        (c) => ({
          subscriptionCategory: c.subscriptionCategory,
        }),
      ],
    },
    eventName: {
      propDefinition: [
        pipedream,
        "eventName",
      ],
    },
    listenerId: {
      propDefinition: [
        pipedream,
        "listenerId",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.pipedream
      .subscribe(this.subscriptionSource, this.listenerId, this.eventName);
    response?.data?.length > 0 && $.export("$summary", "Successfully created Subscription");
    return response;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Subscription category	`subscriptionCategory`	`string`	Select a value from the drop down menu:`OrganisationUserGlob patterns`
Subscription source	`subscriptionSource`	`string`	Select a value from the drop down menu.
Event name	`eventName`	`string`	Select a value from the drop down menu:`$errors$logs`
Listener ID	`listenerId`	`string`	The ID of the component or workflow you'd like to receive events

Action Authentication#

Pipedream uses API keys for authentication. When you connect your Pipedream account, Pipedream securely stores the keys so you can easily authenticate to Pipedream APIs in both code and no-code steps.

About Pipedream#

Integration platform for developers

More Ways to Connect Pipedream + Hostaway#

Other Popular Integrations#

Update Task with Hostaway API on New Scheduled Tasks from Pipedream API

Pipedream + Hostaway

Create a Subscription with Pipedream API on New Message Received from Hostaway API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular