Staywally™
Integrations · 9 min read

Using the public API

The public API is for anything the built-in integrations don't cover — a custom PMS, a data warehouse, your own dashboards. It's a standard REST API with webhooks for the events you care about.

01Authentication

Generate an API key from the admin console and send it as a bearer token on every request. Keys are scoped to your property, so a key can only ever read or write your own tenant's data.

Rotate a key at any time; the old one stops working the moment you revoke it, so issue the new one to your integration first.

02Rate limits

Requests are rate-limited per key to keep the platform fair for every property. Normal integration traffic sits well within the limit; if you're backfilling history, page through results rather than hammering the endpoint, and back off when you receive a rate-limit response.

03Webhooks

Instead of polling, subscribe to webhook events — a request raised, accepted or completed; an order placed or paid; a guest checked out — and we'll POST them to your endpoint as they happen. Each delivery is signed so you can verify it came from us.

Point a webhook at a URL you control, and build the rest of your workflow — a Slack alert, a BI pipeline, a custom folio push — on top of those events.

Didn't answer your question? Raise a ticket and a person will get back to you.