Skip to main content

checkin_types

Read checkins:write Lists your organization’s check-in types, such as drop-in or meeting, and the follow-up question each type asks. The assistant calls this before check_in when you name a visit type or a type needs a follow-up answer. It asks you for the answer rather than guessing. Takes no inputs. Returns
object[]

check_in

Write checkins:write Records a visit to a restaurant as you. The check-in shows up in your Onesauce activity, closes your due follow-ups for that restaurant, and may sync to your CRM, the same as a check-in made in the app.
I just stopped by joespizza.com. Log a drop-in.
string
required
Onesauce ID of the brand or location, e.g. onesauce_id from lookup_by_website.
"brand" | "location"
default:"brand"
Whether entity_id is a brand or a single location.
string
Your organization’s check-in type key, e.g. drop_in. Unknown or missing types are recorded as drop_in.
string
Visit notes. These may sync to your CRM.
datetime
When the visit happened, for logging a past visit. Omit it for a visit happening now.
string
Answer to the check-in type’s follow-up question. It must be exactly one of the options from checkin_types, and it’s required when the type has a follow-up.
Returns
boolean
string
Pass it to set_reminder to follow up on the visit.
string
Link to the restaurant in the Onesauce app.
Onesauce records which assistant made each check-in, for example Claude or ChatGPT.

brand_visits

Read activity:read Lists your past check-ins at a brand’s locations, newest first.
When did I last visit Joe’s Pizza?
string
required
Onesauce brand ID.
Returns
object[]
Each visit’s check_in_id, visited_at, location ID, name and address, check_in_type, and followup_answer.