Connect Citybreak
Summary
Section titled “Summary”The Citybreak tool connects your KonversAI assistant to your Citybreak booking site.
Adding the tool: you add it on the Assistant tools screen in the KonversAI console. Select Settings in the left sidebar, then select AI tools.
What the assistant can then do:
- Look up a visitor’s booking from the Citybreak booking code, such as
ABCD12. Booking lookup always needs a verified email address from the visitor. - With Enable product and availability tools turned on:
- search your products and describe a product;
- check which dates and times an activity has availability;
- give the visitor a link to book.
- With Enable accommodation availability tools turned on:
- search free accommodation for a stay;
- find months with free dates.
What the assistant never does: take a booking, take a payment, cancel or change a booking. The visitor books and pays on your booking site. For cancellations, the assistant points the visitor to My Page and to the contact you set in Support contact.
Who can do this
Section titled “Who can do this”In the KonversAI console:
- A team member with the View tools permission opens the Assistant tools screen.
- A team member with the Modify tools permission adds, edits, validates and deletes the tool.
- A Tenant Admin always holds both permissions.
- Without View tools, the item AI tools does not appear under Settings in the left sidebar. Ask a Tenant Admin to grant Modify tools on the User permissions screen.
With Citybreak: you need a contact at your organisation who can ask Citybreak support for API access.
Before you start
Section titled “Before you start”Citybreak is in the Tool type list for every workspace. You do not need to ask KonversAI to turn it on.
Get these from Citybreak support (help.citybreak.com):
- a Galaxy API key;
- the Point of Sale ID of your booking site.
The key and the Point of Sale ID belong together. Citybreak can also give you a test key for its test environment.
Note these details of your booking site:
- The host name of your booking site, without
https://. For examplebooking.example.com. - The language codes the booking site uses in its addresses. For example
enandnoinhttps://booking.example.com/en/andhttps://booking.example.com/no/.
Email verification: booking lookup needs a verified email address from the visitor. KonversAI includes the Email Verification tool in every workspace, so you do not add it.
Get access from Citybreak
Section titled “Get access from Citybreak”- In Citybreak: Contact Citybreak support at help.citybreak.com. Ask for a Galaxy API key and the Point of Sale ID of your booking site.
Add the Citybreak tool in KonversAI
Section titled “Add the Citybreak tool in KonversAI”- In KonversAI: Select Settings in the left sidebar, then select AI tools. Select + Add tool.
- In KonversAI: Select Citybreak in Tool type. You cannot change the type later.
- In KonversAI: Type a label in Display name, for example
Citybreak. KonversAI fills Slug while you type. - In KonversAI: Type your instruction in Usage guidance for the AI assistant. For example: Use this for questions about our activities, availability and existing bookings.
- In KonversAI: Keep the Enabled checkbox selected.
- In KonversAI: Fill in the Connection card:
- Citybreak Point of Sale ID: the number from Citybreak support, for
example
1234. - Use Citybreak’s test environment: leave this off, unless you use a test key.
- Citybreak Online host: the host name of your booking site, for example
booking.example.com. Do not includehttps://or a path. - Currency: the currency your prices are in, for example
NOK.
- Citybreak Point of Sale ID: the number from Citybreak support, for
example
- In KonversAI: In the Connection card, select Add secret on Galaxy API key. Paste the key, then select Apply.
- In KonversAI: Select Test connection. KonversAI saves the tool, opens it with the heading Edit tool, and shows the result in a banner. A success banner starts with Citybreak credentials are valid. It names your point of sale and the languages it publishes content in.
- In KonversAI: Fill in the Configuration card. The card opens after
a successful connection test.
- Booking-site languages (URL cultures, e.g. en,no,de): the language codes from your booking site’s addresses, separated by commas. The first code is used when the visitor’s language is not in the list.
- Support contact: where visitors go to cancel or change a booking, for
example
booking@example.com. - Label for a product: the word the assistant uses for what you sell,
for example
activity,ticketortrip. - Enable product and availability tools: turn this on to let the assistant answer questions about products and availability.
- Enable accommodation availability tools: turn this on only when your booking site sells accommodation.
- In KonversAI: Select Save changes. KonversAI saves the tool, checks the connection again, and shows the result in a banner.
What can the assistant do once Citybreak is connected?
Section titled “What can the assistant do once Citybreak is connected?”The Citybreak tool always lets the assistant look up a visitor’s booking from the Citybreak booking code. The visitor must verify their email address first.
With Enable product and availability tools on, the assistant can also:
- search your products and describe a product;
- check which dates and times an activity has availability;
- give a link to the product on your booking site.
With Enable accommodation availability tools on, the assistant can also search free accommodation for a stay and find months with free dates.
You add the tool under Settings → AI tools in the KonversAI console.
Can the assistant book, cancel or change a booking in Citybreak?
Section titled “Can the assistant book, cancel or change a booking in Citybreak?”No. The Citybreak tool only reads from Citybreak.
- Booking and paying: the assistant gives the visitor a link, and the visitor books and pays on your booking site.
- Cancelling or changing: the assistant tells the visitor the free cancellation deadline. It points them to My Page on your booking site and to the contact in Support contact.
Set Support contact in the Configuration card of the tool under Settings → AI tools.
Why does the assistant ask the visitor to verify their email before it finds a booking?
Section titled “Why does the assistant ask the visitor to verify their email before it finds a booking?”The Citybreak tool only shows a booking to the person who made it.
- The assistant asks the visitor to verify their email address with a code.
- The tool then checks that this email address matches the email address on the booking.
When the code or the email address does not match: the assistant says that no booking was found for that code and email address. The answer is the same in every case, so the assistant never reveals whether someone else’s code exists.
Email verification: KonversAI includes the Email Verification tool in every workspace, so you do not add it.
What does the assistant tell a visitor about their booking?
Section titled “What does the assistant tell a visitor about their booking?”The Citybreak tool tells the assistant:
- the booking status;
- when the booking was made;
- the booked products with their prices and add-ons;
- any fees;
- the free cancellation deadline, and whether that deadline has passed.
The tool shares the visitor’s own name. It does not share the visitor’s address or phone number. Citybreak does not give dates for each booked item, so the assistant does not state those dates.
Why does the assistant say it cannot check availability for a product?
Section titled “Why does the assistant say it cannot check availability for a product?”The Citybreak tool only states availability that Citybreak reports.
- When Citybreak reports no availability data for a product: the assistant says that it cannot check availability. It gives the visitor a link to the product on your booking site.
- When Citybreak shows the product as sold out: only then does the assistant say that the product is sold out.
Some products sold through your booking site do not report availability to Citybreak. If the products are sold through iTicket, see Connect iTicket.
The banner says Citybreak rejected the API key. What now?
Section titled “The banner says Citybreak rejected the API key. What now?”The banner reads Citybreak rejected the API key. Check the Galaxy API key from Citybreak support.
- Open the Citybreak tool under Settings → AI tools in the KonversAI console.
- In the Connection card, select Update on Galaxy API key. Paste the key from Citybreak support again, then select Apply.
- Check that Use Citybreak’s test environment matches the key: on for a test key, off for a live key.
- Select Test connection again.
The visitor gets answers in English, but my booking site is in Norwegian. What do I change?
Section titled “The visitor gets answers in English, but my booking site is in Norwegian. What do I change?”The Citybreak tool picks the visitor’s language from Booking-site languages (URL cultures, e.g. en,no,de). Open the tool under Settings → AI tools.
- Add the language code your booking site uses in its addresses, for example
en,no. - Select Save changes. The banner lists the languages Citybreak publishes content in.
If the banner says no content is published for a language: ask Citybreak support to publish content in that language for your point of sale.
How do I stop the assistant answering Citybreak questions?
Section titled “How do I stop the assistant answering Citybreak questions?”Select the switch beside the Citybreak tool under Settings → AI tools in the KonversAI console. The switch saves at once, and the word beside it reads Off. The assistant stops using the tool at once. Your settings and your API key stay in place. You need the Modify tools permission.
To keep booking lookup but stop product answers, clear Enable product and availability tools instead. Then select Save changes.
Last reviewed . Tell us when a step no longer matches the product.