Skip to content

First Arrival Blueprint

Jump to bottom
Patrick Luke edited this page Aug 6, 2026 · 4 revisions

First Arrival Blueprint

The repository includes a Home Assistant automation blueprint for first-arrival alerts:

blueprints/automation/hospitable_api/guest_first_arrival.yaml

Import URL:

https://raw.githubusercontent.com/peluke/hospitableHA/main/blueprints/automation/hospitable_api/guest_first_arrival.yaml

HACS installs the custom integration. Home Assistant blueprints are imported separately from the blueprint URL above.

Use one automation instance per property or door lock. This is the cleanest setup when multiple houses use the same pattern but different locks, Hospitable sensors, and notification targets.

What It Does

  • Watches a lock entity for unlocked.
  • Checks the current Hospitable reservation UUID sensor for that property.
  • Ignores repeated unlocks for the same reservation.
  • Optionally requires the lock event attribute method to be keypad.
  • Runs your chosen Home Assistant actions.

Required Home Assistant Helper

Create one input_text helper per house, for example:

input_text.manzanita_last_arrived_reservation
input_text.redwood_last_arrived_reservation
input_text.oak_last_arrived_reservation
input_text.cedar_last_arrived_reservation

The helper stores the reservation UUID that has already triggered an arrival alert for that property. When the next reservation becomes current, the UUID changes and the next first unlock will notify again.

Blueprint Inputs

  • Door lock: the SmartThings lock entity, such as lock.manzanita_door_lock.
  • Current reservation UUID sensor: the Hospitable current reservation UUID sensor for that property.
  • Current guest sensor: the Hospitable current guest sensor for that property.
  • Last arrived reservation helper: the matching input_text helper.
  • Arrival actions: the notification, message, script, or other actions to run.
  • Require keypad unlock: keep enabled when SmartThings provides method: keypad.

Example Arrival Action

Use the variables exposed by the blueprint in any action you configure:

action: notify.mobile_app_your_phone
data:
  title: "{{ arrival_title }}"
  message: "{{ arrival_message }}"

You can also call the integration service to message the current guest:

action: hospitable_api.post_guest_message
data:
  reservation_uuid: "{{ reservation_uuid }}"
  message: "Welcome, your door code was just used. Let us know if you need anything."

Notes

The blueprint uses lock event attributes like:

method: keypad
code_id: "2"
code_name: Charlotte Cropper

Those attributes come from the SmartThings lock entity in Home Assistant, not from Hospitable. Hospitable supplies the reservation context, while SmartThings supplies the unlock event.

Clone this wiki locally