Skip to main content

Add Data connectors for Fin AI Agent [beta]

How to set up Fin with personalized answers that require data from external systems.

Beth-Ann Sher avatar
Written by Beth-Ann Sher
Updated over a week ago

Each Data connector consists of an API call which you can configure behind the scenes. Fin will automatically choose when to use it and deliver a personalized answer to the customer.

You can connect any system which has an API; that might be your unique internal backend tool you have built for your business, or a third party app you're using like Shopify, Salesforce, Stripe, Jira, and more.


Connect to external systems

Navigate to Settings > Integrations > Data connectors and click Create Data connector.

You need the “Can access developer hub” permission to configure an Data connector or set an Data connector live.

If you have one of the supported apps installed, you’ll see a template for this app listed under Create Data connector. We currently support templates for Shopify, Stripe, and Statuspage (more on that below).


Create an Data connector

From a 3rd party template

Data connector templates are available when the following apps are installed in your workspace:

If the app is not already installed, go to the App Store to install. Once the app is installed, Data connector templates for each app will appear as an Data connector ready to set live.

When you click on a template, you’ll see some information about what the Data connector does and you can test it in the Messenger preview. If you’re happy with the Data connector behavior, just select Set live for AI Agent.

The Messenger preview here uses example data. When setting the Data connector live, Fin will use your real customer data.

If you want to configure the Data connector you can click on Customize, which will take you to the Data connector builder for advanced configuration.

If you don’t have one of our supported apps installed, the apps will appear here for you to install them on your workspace. After installation, the relevant Data connector templates will appear in the section above.

Learn more about available Data connector templates and use cases for Fin.

From an AI recommendation

To see AI recommended Data connectors, go to Settings > Integrations > Data connectors and click Create Data connector. You’ll see your unique AI recommended Data connectors under "Create Data connector from template". These are generated based on your conversation history to help you identify potential Data connectors, see what percentage of conversation volume they could resolve, and preview them in the Messenger, before setting anything up.

For AI recommendations to appear, Fin needs to be live on your workspace and you must have sufficient conversation volume.

When you click on an AI recommended Data connector, you’ll find information about what the Data connector does and you can preview it in the Messenger (using example data). AI recommended Data connectors are merely suggestions based on your conversation volume, but they require an API to be connected manually in order to work.

To set the Data connector live, click Set up to configure the API details.

Now all you need to do is connect the Data connector to your API by adding the HTTPS URL.

To further customize this Data connector, see the custom Data connector section below. 👇

From a custom Data connector

To set up a custom Data connector for Fin, navigate to Settings > Integrations > Data connectors and click Create Data connector > Create custom Data connector.

About

First, provide a short name to describe what this Data connector does such as “Get unpaid account balance”. This will help Fin know when to use it.

Next, provide a detailed description explaining when Fin should use this Data connector. Include examples of the data this Data connector provides and customer queries it helps answer.

For example:

Use this Data connector to retrieve recent transData connectors for a customer. This Data connector provides key information such as… Example customer queries include…

See best practices for writing custom Data connector descriptions.

Then check the box to enable Fin to use this action directly without adding it to a workflow or task.

Audience rules

You can customize who this Data connector is available for by clicking Add audience rule. This way, you can set up an Data connector to be used when, for example, a logged in user with a verified email asks about their account balance.

If you want to test the Data connector before enabling it for customers, use the audience rules to enable the Data connector just for you or your teammates initially.

Click Next step when done which will bring you to the API connection section.

API connection

If you want, you can specify if Fin should collect any data before using this Data connector. This can be helpful in cases where you need to make sure data exists before the Data connector is run. For example, you might want to ask the customer for their account number if this is not stored on their user profile in Intercom.

To collect data inputs, click on + Add data input and pick the format of the data that should be collected (text, number, decimal number, or true/false) and give it a name and description so Fin knows how to collect it.

When available, Fin will gather the information from the conversation context.

Next, you must specify the HTTPS URL of your API along with the type of request to be made (GET, POST, etc).

You may want to use attributes available within your workspace, such as a customer’s user ID, to perform a lookup as part of the workflow.

Within an Data connector, you can use people, company and more attributes in the path or body of the request.

You also need to make sure to specify the correct authentication token and to specify correct headers (for example: Accept: application/json or Content-Type: application/json).

Once done, click on Next step to proceed to the next step where you can test your Data connector.

Test response

You’ll need to test this Data connector to make sure it’s fetching the right data from the API you’re connecting to. You can test your Data connector using two methods:

  1. Live response: Test with live response data from your API request to ensure correct configuration. Live response will make an actual API call to your endpoint so be careful in case this request affects any real-world data.

  2. Example response: Provide example JSON data which is useful if your API is not yet fully developed or you need to simulate/mock a particular response.

If everything is looking good, click on Next step to set up your data access.

Data access

When creating custom Data connectors for Fin, there is no need to map response data to Intercom attributes or objects. Instead, Fin directly interprets the JSON response and can then use it to resolve questions. The response is generated based on the ‘Test response’ section. Each line item corresponds to a data point in the JSON response.

By default, Fin can access the full response data to generate replies. Select Restricted data access if you wish to limit the data Fin can read. Check the data fields you want to give Fin access to.

You can also edit the individual data items by clicking on the edit icon to give your response data a customer facing name as well as specify any transformations to the data.

For example, if the API response returns a balance of 0, instead of Fin stating the unpaid balance is 0, it can reply stating that there is currently no unpaid balance remaining.

Then click Set live and that’s it, Fin’s ready to use your custom Data connector. 🎉


Rolling out Data connectors

We recommend using audience rules to roll out Data connectors in phases to your customer base. This enables you to validate the performance of the Data connector and make tweaks/changes where necessary.

Monitor and manage

To find existing Data connectors, navigate to Settings > Integrations > Data connectors. The Data connectors enabled for Fin show a tick below "Usage" and you can see whether they're Live below the "Status" column.

Viewing in the inbox

Go to the Inbox conversation and select Show conversation events. Events will show if Fin has access to the Data connector and if the Data connector is successfully triggered.

Note:

  • If there’s an error with the Data connector triggering, select Logs to find out why.

  • Fin may not always choose to use the Data connector despite making an API request if other content is determined to be more relevant.

Inbox views can be created with the attribute “Fin AI Agent: Data connector used in reply”. This attribute is set if Fin calls an Data connector and uses some or all of the response in an answer.


Troubleshooting

For troubleshooting purposes, all response data generated by custom Data connectors triggered by Fin is recorded for up to 7 days. You can access these logs under the specific Data connector in Logs.

You can view response data based on what kind of data Fin has access to.

  • Entire response – Full, unmodified response

  • Redacted & Formatted response – After transformation

  • No response data


💡Tip

Need more help? Get support from our Community Forum
Find answers and get help from Intercom Support and Community Experts


Did this answer your question?