rainmaker.connect

One normalized API for the entire rainmaker.pulse hospitality platform. Manage reservations, guests, reviews, payments, and more across 20+ PMS systems.

Quickstart

Get up and running in under 5 minutes.

1. Get your API key

Request an API key from the Connect Developer Portal. Keys are scoped per tenant and per environment (production vs. sandbox).

2. Make your first request

curl -X GET "https://connect.rainmakerpulse.ai/v1/{businessId}/reservations" \
  -H "X-API-Key: sk_live_your_key_here" \
  -H "Content-Type: application/json"

3. Explore the interactive reference

Scroll down for the full interactive API reference powered by Scalar, or jump directly to a domain:

Authentication

All requests must include one of these authentication methods:

API Key

Pass your key in the X-API-Key header. Best for server-to-server integrations.

X-API-Key: sk_live_abc123...

OAuth 2.0 Bearer Token

Use the /oauth/token endpoint with client credentials to obtain a JWT. Best for partner integrations.

Authorization: Bearer eyJhbGci...

Sandbox keys (prefix sk_sandbox_) hit a test environment with synthetic data. Production keys (prefix sk_live_) access real tenant data.

Canonical Schemas

rainmaker.connect normalizes data from 20+ PMS providers into a single canonical schema. Regardless of whether your tenant uses Apaleo, Mews, Opera, or any other PMS, the response shape is always the same.

Reservation

Normalized reservation with reservationId, arrivalDate, departureDate, status (confirmed, checked_in, checked_out, cancelled, no_show), guest info, and financials.

Guest

Profile with firstName, lastName, email, phone, address fields. PII fields require the guests:pii scope.

Room

Physical unit with roomId, roomNumber, roomTypeId, occupancy status, condition, and max capacity.

Folio

Financial record with folioId, balance, currency, linked charges and payments.

Event Catalog

Subscribe to real-time webhook events. Events follow the {domain}.{action} convention.

Reservation Events

  • reservation.created
  • reservation.modified
  • reservation.cancelled
  • reservation.checked_in
  • reservation.checked_out
  • reservation.no_show

Room Events

  • room.status_changed
  • room.out_of_order
  • room.assigned
  • room.moved

Folio Events

  • folio.charge_posted
  • folio.payment_posted
  • folio.settled

Guest & Review Events

  • guest.profile_updated
  • guest.message_received
  • review.received
  • review.response_posted

SDKs

Auto-generated client libraries are available as CI artifacts. They are generated from the OpenAPI spec on every change.

TypeScript / Node.js

@rainmaker/connect-sdk - Full type safety, tree-shakeable.

Python

rainmaker-connect - Async-ready, Pydantic models.

PHP

rainmaker/connect-sdk - PSR-18 compatible HTTP client.

Interactive API Reference

Full endpoint documentation with try-it-out capability.