Integrations

This page connects your assistant to the rest of your company: your website, your own systems and, if your company sells, a commerce platform. Changes here apply right away. There is no draft or publish step.

What you see

• Install on your site: the code to add to your website, the list of allowed domains, and the setting for signed-in customers.
• Connect an API: a form to connect your own API, and a table of the APIs you have connected.
• Connect a commerce platform (Magento): only shown if your company has the commerce capability. A form and a table of your connections.

How to install the assistant on your website

1. Under Install on your site, copy the script tag.
2. Paste it anywhere before </body> on your pages, or into a Google Tag Manager Custom HTML tag.
3. Under Add a domain, type your site's host name. You can use an exact host, *.example.com for all subdomains, or localhost:3400 for testing.
4. Choose production or staging under Environment.
5. Click Add.

The assistant appears on every page that loads the tag, but only on domains in the list. To stop serving a domain, click Remove next to it.

How to let the assistant act for signed-in customers

If customers sign in to your website, the assistant can act for them. Your server signs a short-lived proof of who the customer is with a secret, and the page passes it to the assistant.

1. Under Signed-in customers, click Generate secret.
2. Copy the secret right away. It is not shown again.
3. Give it to whoever runs your website's server. Keep it on the server, never in page code.

The chip next to the buttons shows on or off. To replace the secret, click Rotate secret. To stop recognizing signed-in customers, click Turn off. Without a secret, every visitor is a guest.

How to connect your own API

Connect an API so your flows can answer with your own data, such as loyalty points, account status or bookings.

1. Under Connect an API, enter a Name and a Base URL. Every call goes under this address.
2. Under How the API knows it is you, choose No key, Bearer token or Key in a header. For a header, also enter the Header name. Then enter the token or key.
3. Optionally, set a Signing key so your API can check that calls come from the assistant. Click Generate to create one.
4. Set the Test path. It is called to check the connection.
5. Turn on Send the signed-in customer's id if your API needs to know which customer is asking. It is never sent for a guest.
6. Click Connect and test.

If you set a signing key, it is shown once after connecting. Give it to whoever runs the API.

The connected API appears in the table with its sign-in type and the result of the last check. Click test to check it again. To use it, add it as a data source step in Flows.

To update an API, connect it again with the same name. If you leave the token or key empty, the stored one is kept.

How to connect a commerce platform

1. Under Connect a commerce platform (Magento), enter the Commerce site domain.
2. Click Connect.
3. In the table, click probe to check the connection.
4. If you have more than one connection, click make primary on the one the assistant should use by default.

Good to know

• API calls only go over https to public addresses.
• Keys and tokens are stored encrypted and are never shown again after you save them.