API reference / Support Agent
Read the guide of the chat
The places of your product that the chat can show a customer: each one a page by its path, with words that say what is there. An element with data-troopy-guide and the name of the place gets the ring. readsPage says whether a message of the chat carries the names of the links and buttons of the page of the customer. Not found while Liquid SaaS is off.
/api/v1/support-liquid/guidesOther ways to call it
troopy liquid guidestroopy_get_liquid_guidesResponse
200 · application/jsondata*object3 properties
guides*array<object>5 properties
name*stringabout*stringAt least 1 characters · At most 120 characters
path*stringAt most 200 characters
mark*enum<string> | nullfound: a page of the website had the mark of the place. missing: a customer pressed Show me, and its page had no mark. Null: no visitor opened the page yet
foundmissing
markAt*string | nullWhen the chat said so
readsPage*booleantours*array<object>At most 5 items
4 properties
name*stringtitle*stringAt least 1 characters · At most 60 characters
path*stringAt most 200 characters
steps*array<object>At most 4 items
2 properties
to*stringsay*stringAt least 1 characters · At most 140 characters