Examples

A few common actions to get you started. Adapt the URLs and fields to your own tools.

Book an appointment

• When to use: "Use when a visitor wants to book. Collects a date, time and email, checks availability, and creates the booking."
• Inputs: preferred_date, preferred_time, email
• Request: POST https://api.yourbookingtool.com/appointments
• Options: turn on Ask the visitor to confirm first.

Check availability / stock

• When to use: "Use when a visitor asks whether something is in stock or available."
• Inputs: sku (or product)
• Request: GET https://api.yourstore.com/stock?sku={{sku}}
• Options: no identity needed — this is public info.

Look up the visitor's own order

• When to use: "Use when a visitor asks about their own order status."
• Inputs: none from the visitor — the order is scoped to their verified email.
• Request: GET https://api.yourstore.com/orders?email={{verified_email}}
• Options: turn on Requires a verified visitor.

Create a support ticket

• When to use: "Use when a visitor has an issue to report."
• Inputs: subject, details, email
• Request: POST https://api.yourhelpdesk.com/tickets