Free Guide · Integrations

The Beginner's Guide to MayiStay Integrations

Integrations let other tools talk to MayiStay for you — so a new booking in your property management software can add the renter to MayiStay automatically, and a new review can trigger a Slack message or email. This guide walks you through it from zero, in plain language. No coding required for the Zapier path.

What you can do with integrations

• Add renters automatically — new guests/tenants flow into your database.
• Submit ratings from another system.
• Search a renter's history before you accept a booking.
• Receive real-time events (like a new review) via a webhook.

Everything runs on your API key — a private password that lets a tool act on your account. So the first step is always to create one.

Step 1 — Create your API key

This is the master step. Everything else needs it.

• Sign in to MayiStay and, in the left sidebar, go to Dashboard → Integrations.
• In the MayiStay API card, click Generate.
• Your key appears once (it starts with ms_sk_…). Click the copy button and paste it somewhere safe — a password manager is ideal. For security we never show it again; afterward you'll only see a masked preview like ms_sk_ab12••••••••7f9c.
• Lost it, or think it leaked? Click Rotate to create a fresh key. The old key stops working immediately, so update any tool that used it.

Treat the key like a password: anyone who has it can add renters and post reviews on your behalf. Never share it publicly or paste it into email/chat.

Step 2 — The easy way: connect with Zapier (no code)

Zapier connects thousands of apps without any coding. A "Zap" is just: when this happens → do that. For MayiStay, the best source is Hospitable, a property manager that syncs your Airbnb, VRBO, Booking.com and direct guests.

Here's the classic setup — new reservation becomes a MayiStay renter automatically:

• In MayiStay, open Integrations and click Connect on Zapier.
• Create a free Zapier account and start a new Zap.
• Trigger: choose your source app (e.g. Hospitable) → "New Reservation".
• Action: choose MayiStay → "Add Renter".
• When Zapier asks you to connect MayiStay, paste the API key from Step 1. That's how Zapier proves the Zap is really you.
• Map the guest's first name, last name and date of birth into the fields, then turn the Zap on.

Other popular Zaps you can build the same way:

• New review in MayiStay → post to Slack or send yourself an email.
• New row in Google Sheets → Add Renter to MayiStay.
• New lead in your CRM → Find Renter in MayiStay to check their history first.

Step 3 — Using the Webhook URL (real-time events)

A webhook is a URL you own that MayiStay calls the moment something happens — so your own system gets notified instantly, without you building anything that has to keep asking "anything new yet?".

• In Integrations → Webhook (advanced), paste the URL that should receive events (for example a Zapier "Catch Hook" URL, or an endpoint on your own server), then click Save Changes.
• From then on, whenever you submit a new review, MayiStay sends a POST request to that URL with a JSON body.

The body always looks like this — an event name plus a data object:

POST https://your-endpoint.example.com/mayistay
Content-Type: application/json

{
  "event": "review.created",
  "data": {
    "id": "rev_...",
    "renter": {
      "publicId": "vcocwz-156",
      "firstName": "Jordan",
      "lastName": "Avery",
      "avgRating": 4.83,
      "ratingsCount": 12
    },
    "overallRating": 5,
    "wouldRentAgain": true,
    "comments": "Great guest — left the unit spotless.",
    "createdAt": "2026-07-08T14:03:00.000Z"
  }
}

Tip: to see it working, paste a free test URL from a tool like Zapier's "Catch Hook" or a request inspector, submit a review, and watch the event arrive.

For developers — call the API directly

Prefer to integrate in code? Every request uses your API key in the Authorizationheader. Base URL:

https://mayistay.com/api/v1

Add a renter (idempotent — the same person is never duplicated):

curl -X POST https://mayistay.com/api/v1/renters \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "firstName": "Jordan",
        "lastName": "Avery",
        "dateOfBirth": "1990-06-14"
      }'

Search a renter before accepting a booking:

curl "https://mayistay.com/api/v1/renters/search?firstName=Jordan&lastName=Avery&dob=1990-06-14" \
  -H "Authorization: Bearer YOUR_API_KEY"

Submit a rating (stars 1–5; the four sub-scores are only needed below 5):

curl -X POST https://mayistay.com/api/v1/reviews \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "firstName": "Jordan",
        "lastName": "Avery",
        "dateOfBirth": "1990-06-14",
        "overallStars": 5,
        "wouldRentAgain": true,
        "comments": "Excellent guest."
      }'

You can confirm a key is valid at any time with GET https://mayistay.com/api/v1/me — it returns your host account. A missing or bad key returns 401 Unauthorized.

Keep your key safe

• Store it in a password manager or your tool's secret settings — never in public code.
• Use Rotate if it's ever exposed; then update every tool that used it.
• One key represents your whole account, so only share it with services you trust.