Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hostaway Webhooks API

Manage unified webhooks for the three Hostaway event types — reservation created, reservation updated, and new message received. Failed deliveries retry up to three times before a failure email is sent to the configured alert recipient.

Hostaway Webhooks API is one of 16 APIs that Hostaway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Vacation Rentals, Webhooks, and Events. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.hostaway.com/v1.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://api.hostaway.com/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Hostaway Webhooks API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Webhooks 5

Unified event webhooks

GET
/webhooks/unifiedWebhooks
Hostaway List Unified Webhooks
listUnifiedWebhooks → 200
POST
/webhooks/unifiedWebhooks
Hostaway Create Unified Webhook
createUnifiedWebhook body → 200
GET
/webhooks/unifiedWebhooks/{webhookId}
Hostaway Get Unified Webhook
getUnifiedWebhook 1 param → 200
PUT
/webhooks/unifiedWebhooks/{webhookId}
Hostaway Update Unified Webhook
updateUnifiedWebhook 1 param body → 200
DELETE
/webhooks/unifiedWebhooks/{webhookId}
Hostaway Delete Unified Webhook
deleteUnifiedWebhook 1 param → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are WebhookInput (5 properties), StandardResponse (2 properties), WebhookResponse (2 properties), WebhookListResponse (2 properties). Each schema is shown below with its type and property counts.

WebhookListResponse
object
2 properties
WebhookInput
object
5 properties 1 required
WebhookResponse
object
2 properties
StandardResponse
object
2 properties
Webhook

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hostaway-webhooks-api-openapi.yml Raw ↑

Other APIs Hostaway publishes across the network.

Hostaway Listings API
Hostaway Reservations API
Hostaway Calendar API
Hostaway Messaging API
Hostaway Finance API
Hostaway Tasks API
Hostaway Custom Fields API
Hostaway Guest Payments API
Hostaway Reference Data API
Hostaway Listing Amenities API
Hostaway Listing Bed Types API
Hostaway Listing Images API