junte/Model
1
0
Fork 0
mirror of https://github.com/Hestia-Homes/Model.git synced 2026-07-27 23:35:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add docs for Ops

Browse source
This commit is contained in:
Daniel Roth 2026-07-20 08:54:12 +00:00
parent 9c0bddd14d
commit d6226f8232
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/abri-hubspot-ops-guide.md
View file

@ -26,9 +26,9 @@ counts.
| When you… | Abri's system… | How you know it worked |
|---|---|---|
| Set **Expected commencement date** for the first time | Sends us the tenancy details for the property | Tenant contact records appear in HubSpot, linked to the deal |
| Set **Confirmed survey date** for the first time | Creates the survey booking (a "job") against the property, assigned to the surveyor on the deal | Abri's job number appears in **Client booking reference** on the deal |
| Change **Confirmed survey date**, **Confirmed survey time** or **Third-party surveyor identifier** on a deal that already has a booking | Updates the existing appointment — new date/time and/or reassigns it to the new surveyor | The deal keeps the same Client booking reference |
| Set **Expected commencement date** for the first time | Sends us the tenancy details for the property | Tenant contact records appear in HubSpot, linked to the deal |
| Record a **3rd attempt** (Number of attempts reaches 3) **and** set **Outcome** to an unsuccessful value (see below) | Cancels the booking as abandoned | — (this only fires once per deal) |
**Unsuccessful outcomes** that count towards abandonment — the wording must match exactly:
@ -45,10 +45,10 @@ system.
| HubSpot deal field | What it feeds |
|---|---|
| **Expected commencement date** | Setting it the first time triggers the tenant-details fetch |
| **Confirmed survey date** | The appointment date sent to Abri |
| **Confirmed survey time** | The appointment slot: `morning` → AM, `afternoon` → PM, a clock time like `09:30` → AM/PM by whether it's before midday, left blank → all day |
| **Third-party surveyor identifier** | Which surveyor the booking is assigned to in Abri's system. **Required** — a booking or appointment change cannot be sent without it, and it must be one of Abri's valid surveyor codes. Changing it on a deal that already has a booking reassigns that booking to the new surveyor |
| **Expected commencement date** | Setting it the first time triggers the tenant-details fetch |
| **Number of attempts** + **Outcome** | Together they trigger abandonment (3+ attempts and an unsuccessful outcome) |
| **Client booking reference** | Abri's job number, written back **by the system** after the booking is created |
| **Deal name** | Used as the job description Abri's staff see |
@ -70,12 +70,12 @@ It is written automatically with Abri's job number and is how the system finds t
booking when you later change or abandon it. If you overwrite or clear it, appointment
changes and abandonments will stop working for that deal.
### The surveyor identifier must be a valid Abri code
### The surveyor identifier (Third-Party Surveyor Identifier) must be a valid Abri code
Free-typed or misspelt values will be rejected by Abri's system and the booking won't be
made. The tech team holds the current list of valid surveyor codes from Abri — use a
value from that list. (Longer term this field will be set automatically from the deal
owner; until then it's set by hand.)
value from that list. Soon this field will be set automatically from the deal
owner.
### Outcome wording is exact