Skip to main content

Webhooks

Webhooks are a way to receive real-time notifications from the API when a specific event occurs.

Supported events:

Event Key	Description
`screening_webhook_url`	Triggered when the verification status of a reservation changes.
`guest_portal_webhook_url`	Triggered when a guest submits their information through the Guest Portal.
`stargate_webhook_url`	Triggered when a Stargate message is triggered.
`reservation_webhook_url`	Triggered when a reservation is created or updated.
`listing_webhook_url`	Triggered when a listing is created or updated.
`account_webhook_url`	Triggered when a user is created or updated.

Registering webhooks

There are two ways to register webhooks:

Using the API
Using the Dashboard

Registering webhooks using the API

See the API reference for creating a webhook.

Registering webhooks using the Dashboard

Login to the Dashboard.
Navigate to the Settings page.
Click on the Advanced tab and scroll down to the Webhooks section.
Enter the webhook URLs for each event you want to receive notifications for.

Webhook events

There are 6 different events that can trigger a webhook notification:

Verification status changed
Guest Portal information submitted
Stargate message triggered
Reservation created or updated
Listing created or updated
User created or updated

Verification status changed

Event key: screening_webhook_url

Webhook payloads for this event contain the following fields:

{
  "id": "XXXX",
  "status": "review",
  "guestportal_completed": true,
  "reason": "User changed verification status",
  "business_rules": [
    "Last minute reservation"
  ],
  "notes": "Approved - ID, name and selfie matches.",
  "supervised": "approve"
}

Guest Portal information submitted

Event key: guest_portal_webhook_url

Webhook payloads for this event contain the following fields:

{
  "id": "XXX",
  "listing_id": "XXXX",
  "confirmation_code": "XXXXX",
  "pms_status": "CONFIRMED",
  "guestportal_completed": null,
  "origin_reservation_id": "XXXXX",
  "reason": "Guest Portal not completed",
  "business_rules": [],
  "status": "pending",
  "supervised": null
}

Stargate message triggered

Event key: stargate_webhook_url

Webhook payloads for this event contain the following fields:

{
  "email": "user@example.com",
  "phone": "+14155555555",
  "tag": "ci",
  "method": "email",
  "via": "hostaway",
  "sendAfter": "2023-08-13T20:00:00.000Z",
  "checkInDate": "2023-08-15T20:00:00.000Z",
  "checkOutDate": "2023-08-16T15:00:00.000Z",
  "created": "2023-08-13T20:19:00.168Z",
  "updated": "2023-08-13T20:19:00.168Z",
  "message": {
    "subject": "Your Upcoming Reservation",
    "text": "Hi Daniela, Your stay is coming up, we look forward to hosting you! Access your check-in details now: https://example.com/check-in/xxxxxx Thank you, ACME Inc.",
    "html": "<p>Hi Daniela,</p><p><br></p><p>Your stay is coming up, we look forward to hosting you!&nbsp;</p><p><br></p><p>Access your check-in details now: https://example.com/check-in/xxxxxx/</p><p><br></p><p>Thank you,</p><p>ACME Inc.</p><img src=\"https://example.com/check-in/xxxxxx.png\" width=\"0\" height=\"0\"/>"
  },
  "reservation_id": "XXXX",
  "listing_id": "XXXXX",
  "confirmation_code": "XXXXX"
}

Reservation created or updated

Event key: reservation_webhook_url

Webhook payloads for this event contain the following fields:

{
  "id": "XXXXXX",
  "status": "CONFIRMED",
  "source": "Direct",
  "integration_source": "Stayntouch",
  "user_id": "XXXXXX",
  "listing_id": "XXXXXX",
  "listing_name": "EX001 - 30+ 1BR Apt in South Loop Chicago High-Rise",
  "listing_nickname": "EX001",
  "listing_city": "Chicago",
  "listing_address": "100 S Michigan Ave, Chicago, IL 50601, USA",
  "listing_timezone_name": "America/Chicago",
  "confirmation_code": "XXXXX",
  "number_of_guests": 1,
  "nights": 44,
  "total_price": 5529.95,
  "check_in_date": "2023-09-14T21:00:00.000Z",
  "check_in_time": 16,
  "check_out_date": "2023-10-28T16:00:00.000Z",
  "check_out_time": 11,
  "guest": {
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "phone": "14155555555",
    "email": "johndoe@exaple.com",
    "location": "1 Key Hwy, Baltimore, MD, 11235",
    "metadata": null,
    "birth_date": null
  },
  "created_at": "2023-08-15T12:36:29.473Z",
  "updated_at": "2023-08-15T14:15:54.516Z",
  "average_daily_rate": 126,
  "verification_status": {
    "pms_status": "CONFIRMED",
    "guestportal_completed": true,
    "reason": "User changed verification status",
    "supervised": "approve",
    "business_rules": [],
    "status": "review",
    "notes": "MA"
  },
  "guestportal": {
    "confirmation_code": "XXXXX",
    "full_name": "John Doe",
    "updated_at": "2023-08-15T12:53:57.982Z",
    "phone": "+14155555555",
    "last_step": "Finish",
    "email": "johndoe@example.com",
    "guests": [
      {
        "full_name": "John Doe",
        "email": "johndoe@example.com"
      }
    ],
    "signature": "John Doe",
    "completed": true,
    "completed_at": "2023-08-15T12:53:56.760Z"
  },
  "identification": {
    "first_name": "John",
    "last_name": "Doe",
    "middle_name": "",
    "document_number": "",
    "document_type": "",
    "sex": "M",
    "nationality": "",
    "address": "",
    "issuer": "",
    "birth_date": "1985-08-12",
    "expiry_date": "2032-08-12T00:00:00.000Z",
    "issue_date": "2022-08-12T00:00:00.000Z"
  }
}

Listing created or updated

Event key: listing_webhook_url

Webhook payloads for this event contain the following fields:

{
  "id": "XXX",
  "my_id": "MH70_318",
  "user_id": "XXXX",
  "integration_source": "API",
  "name": "Dream House - New York City",
  "nickname": "318",
  "property_type": "Apartment",
  "accommodates": 4,
  "bedrooms": 1,
  "bathrooms": 1,
  "beds": 1,
  "check_in_time": 15,
  "check_out_time": 11,
  "location": {
    "neighborhood": "Manhattan",
    "address": "700 Alex Street, New York, NY 10045, USA",
    "street": "700 Alex Street",
    "apartment": null,
    "city": "New York",
    "country": "United States",
    "country_code": "US",
    "state": "New York",
    "smart_location": "New York, United States",
    "zipcode": "10045",
    "geo": {
      "lat": 0.0,
      "lon": 0.0
    },
    "time_zone_name": "America/New_York",
    "building": "MM700",
    "state_code": "NY",
    "county_code": "New York County",
    "county": "New York County",
    "street_name": "Alex Street",
    "street_number": "700"
  },
  "pictures": {
    "thumbnail_url": "",
    "large_url": "",
    "regular_url": ""
  },
  "status": "ACTIVE",
  "updated_at": "2023-08-15T14:50:43.953Z",
  "created_at": "2021-11-29T10:57:09.333Z",
  "guest_portal_screens": {
    "GuestList": "disabled"
  }
}

User created or updated

Event key: account_webhook_url

Webhook payloads for this event contain the following fields:

{
    "id": "XXXX",
    "name": "Account Name",
    "email": "customer@example.com",
    "phone": "+14155555555",
    "created_at": "2023-08-15T14:50:43.953Z",
    "updated_at": "2023-08-15T14:50:43.953Z",
    "last_login": "2023-08-15T14:50:43.953Z",
    "is_active": true,
    "is_suspended": false,
    "company": {
        "name": "Company Name",
        "email": "support@example.com",
        "phone": "+14155555555"
    },
    "billing": {
      "parent_account": "XXXX"
    },
    "settings": {
      "guest_portal_screens": {

      },
      "guest_portal_screens_settings": {

      },
      "business_rules": [

      ]
    }
}

Autohost