Skip to main content

How to set up Data connectors

How to set up Data connectors with external systems for personalized Fin answers and other automations.

Written by Beth-Ann Sher

Use this article to set up, configure, and manage Data connectors — the feature that lets Fin retrieve live data from your external systems and give customers personalized answers without waiting for a teammate. You'll learn how to create a connector from a template or from scratch, configure its API endpoint, shape the response, control who can trigger it, handle security, roll it out safely, and monitor its performance.

Note: You need the "Can access developer hub" permission to create, edit, or set a Data connector live.


How do Data connectors work?

Each Data connector consists of an API (application programming interface) call that you configure. Fin automatically determines when to use it to deliver customer-specific answers. You can connect any system with an API, including:

  • Custom internal backend tools

  • Third-party platforms (Shopify, Salesforce, Stripe, Jira, etc.)

Diagram showing how a Data connector links Intercom's Fin AI agent to an external system via an API call, enabling Fin to retrieve customer-specific data and include it in its reply.

Tip: Data connectors can be used by Fin in Procedures and other automations, including Workflows and macros from the Inbox. Learn more about how to design and use your APIs with Data connectors.


How to create a Data connector

Screenshot of the Data connectors page in Settings > Integrations > Data connectors, with the New button highlighted.

If you have one of the supported apps installed, you’ll see a template for this app listed under Create Data connector. Templates are currently available for Shopify, Stripe, and Statuspage — see From a 3rd party template below for details.

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.

Screenshot of a Data connector template card showing a preview of Fin's response in the Messenger and a 'Set live for AI Agent' button.

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 New 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.

Screenshot of an AI-recommended Data connector card showing its description, estimated conversation coverage percentage, and a Messenger preview.

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 From a custom Data connector section.

Create a custom Data connector from scratch

To set up your own custom Data connector for Fin, navigate to Settings > Integrations > Data connectors and click + New > + Create from scratch.

Screenshot of the New Data connector screen with 'Create from scratch' selected, showing the four-phase setup tabs: API, Data, Fin, and Security.

Phase 1: API

The API tab defines how Intercom communicates with your external system.

Screenshot of the Identity section in the API tab, showing fields for connector name and internal description.

Give your connector a short, descriptive name — for example, "Get unpaid account balance." This helps Fin understand when to use it. Add an internal description for your team's reference.

See best practices for writing Data connector descriptions.

Note: Emojis aren't supported in Data connector names and will throw an error if included.

Data inputs

Data inputs let you specify what information Fin needs to collect before the connector runs — for example, a customer's account number if it's not already stored in Intercom. When Fin needs to pass a search query or other value to the API based on what a customer asks, add a data input and set the source to Let Fin collect — Fin will gather the value automatically from the conversation.

Screenshot of the Data inputs section showing an example input field with name, description, format type, and source options.

Click + Data input and choose a format:

  • Text

  • Number

  • Decimal number

  • True/False

Give each input a name and description so Fin knows how to collect it. You can also set a fallback value for cases where the API returns a null or missing response.

For each input, choose where the data comes from:

Screenshot of the data input source dropdown showing three options: Let Fin collect, People attribute, and Custom value.
  • Let Fin collect — Fin gathers it from the conversation automatically

  • People attribute — pulled from an existing Intercom attribute

  • Custom value — a fixed value you define

API endpoint

Add the HTTPS (secure web) URL for your API endpoint and select the HTTP request method: GET (retrieve data), POST (submit data), PUT (replace data), DELETE (remove data), or PATCH (partially update data).

Screenshot of the API endpoint section showing a text field for the HTTPS URL and a dropdown for the HTTP method (GET, POST, PUT, DELETE, PATCH).

Use the Attribute Inserter to pass dynamic values — like a customer's user ID — directly in the URL path or request body.

Authentication and headers

Select an authentication token and add any custom key-value headers your API requires (for example, Content-Type: application/json).

Note: If you're sending a JSON request body (POST, PUT, or PATCH), you must explicitly add a Content-Type: application/json header. Without it, the receiving API won't parse the request body and will reject all fields as invalid — even if the JSON is correctly formatted.

Screenshot of the Authentication and headers section showing a token selector and a key-value pair editor for custom HTTP headers.

Note: You can attach multiple tokens to a single connector. Each token must use a different header key — all attached tokens are sent with every request.

Once the endpoint URL and authentication details are complete, click Test connection to validate your setup. A successful test returns a green confirmation and the raw API response. A failed test displays the HTTP error code and a description — resolve any errors before proceeding to Phase 2: Data.

Screenshot of the Test connection result panel showing a green success status and the raw JSON API response.


Phase 2: Data — shaping the API response

The Data tab controls how the API response is filtered and transformed before Fin uses it to answer customers. You can restrict which fields Fin sees and reshape the data using a visual editor or Python code.

Screenshot of the Data tab showing the Restrict and shape section with Table view and Python transform options.

Restrict and shape

By default, Fin has access to the full API response. To limit what Fin can read, switch to Manually restrict access and select only the fields you want to expose.

Note: When using Manually restrict access, fields whose names contain special characters — such as parentheses (), plus signs +, or slashes / — may be silently excluded from the data Fin receives, due to a path matching bug. To work around this, rename the affected fields to remove special characters before restricting access. Alternatively, use full data access if the response does not contain sensitive data.

Choose how you'd like to transform the response:

  • Table view — filter fields, rename them, and set field-level transformations using a visual editor

  • Python — write Python code to clean, reshape, or reformat the response before it reaches Fin

Object mapping

Object mapping lets you map API response fields directly to Intercom contact or company attributes, automatically syncing data from your external system to your Intercom workspace.

Click Test code to validate your Python transformation logic, and Test connection to confirm the full API call and response shape. Resolve any errors before proceeding to Phase 3: Fin.

Note: When you select object mapping, you will see only mapped objects in Workflows and Procedures; whereas without mapping, all options selected in the Restrict and shape the data table will be listed. For Python, only returned values will be seen


Phase 3: Fin — how Fin triggers the connector

The Fin tab controls whether Fin triggers the Data connector automatically or only when explicitly called from a workflow, procedure, or macro. Choose the trigger mode that matches how sensitive or write-active the connector is.

Tip: Before Fin can use a connector, make sure each of the following is in place:

  • Data inputs: For any value Fin needs to pass to the API — such as a search query, product name, or order ID — add a data input with the source set to Let Fin collect. This tells Fin to gather the relevant terms from the conversation and pass them to the API automatically.

  • Test connection: Run a successful test using real data (Phase 1). The test response shapes what Fin will see and return to customers — example data won't reflect real results.

  • Fin trigger: In this Fin tab, set How should Fin use this connector? to Enabled (direct trigger).

  • Connector description: Write a clear, focused description of what the connector does and when to use it. This is how Fin decides when to call it.

  • Set live: Complete the security checks in Phase 4, then click Save and Set live.

How should Fin use this connector?

Enabled (direct trigger)

Fin triggers the connector automatically based on the customer's question — no workflow required. Best for read-only connectors like "Check order status" and high-volume, repeatable queries.

Screenshot of the Fin tab with 'Enabled (direct trigger)' selected, showing the audience rules configuration panel.

You can control who this Data connector is available to with reusable Fin audiences, or by creating a custom audience specifically for this connector. For example, you might make it available to customers in your "Enterprise plan" audience, or restrict it to a custom audience such as logged-in users with a verified email who ask about their account balance.

Note: You can now use Fin audiences with Data connectors. Fin audiences are reusable customer groups you create once and then apply across multiple connectors—making it easier to keep things consistent.

  • You can choose Everyone, a reusable Fin audience, or a Custom audience for one-off rules.

  • You can select multiple Fin audiences, but you can’t combine Custom rules with a Fin audience.

  • Any existing Data connector audience rules you configured will become a Custom audience to preserve functionality.

Tip: 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.

Disabled (manual trigger)

The connector won't run automatically. You'll need to add it manually to a Workflow, Procedure, or Macro. Best for sensitive or write-active connectors — like "Delete account" — where you want human or workflow oversight before anything runs.

Screenshot of the Fin tab with 'Disabled (manual trigger)' selected, showing a note that the connector must be added manually to a workflow, task, procedure, or macro.

Use Fin preview to see exactly how Fin will respond using this connector before setting it live.


Phase 4: Security — access control and going live

The Security tab is the final step before going live. It controls whether customers must be authenticated before the Data connector can access or display their data.

Screenshot of the Security tab showing the customer authentication toggle and the security check panel.

Customer authentication

Toggle this on to enforce your workspace's authentication rules before the connector can access or display sensitive information. Authentication rules are configured at Settings > Workspace > Security > Customer authentication.

Security check

Run a diagnostic to assess the health and security of your API setup. Any risks are surfaced with actionable recommendations — resolve them before setting the connector live.

Once all security checks pass, click Save and then Set live. The Data connector status changes to Live in Settings > Integrations > Data connectors. Fin will begin using it immediately for conversations that match the configured audience.

Important: There are a few potential ways that Fin could accidentally share information from another user when parameter passing. See our recommended settings to best mitigate the risks.


How to roll out Data connectors safely

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

Data connectors require AI Answers to be enabled in the workflow step for Fin to use them. AI Answers cannot be enabled in test workspaces, so Data connectors can only be fully tested in production environments. Use test user profiles in production for safe testing.

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.

How to monitor and manage Data connectors

To find existing Data connectors, navigate to Settings > Integrations > Data connectors. The Data connectors list shows the following details for each connector:

  • Name and status (live or draft)

  • General usage (total executions)

  • Fin usage — resolution rate and the audience it's available to

  • Health — API success rate and an overall health indicator

  • Security status

  • Configuration details

Click a connector row to open its health dashboard, where you can review usage, performance metrics, and execution logs, or open the configuration editor to make changes.

Screenshot of the Data connectors list view showing connector rows with columns for name, status, general usage, Fin usage, health, and security.

How to view Data connector activity in the Inbox

To see Data connector activity for a specific conversation, open the conversation in the Inbox and select Show conversation events. The events panel shows whether Fin had access to the Data connector and whether it was successfully triggered.

Screenshot of the Inbox conversation events panel showing a Data connector trigger event with its success status.

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.

  • Fin cannot query custom attributes or event data for answers. To enable Fin to respond with real-time asset data, set up Data Connectors so Fin can access external data sources via API.

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

Screenshot of the Inbox view filter configuration showing the 'Fin AI Agent: Action used in reply' attribute selected as a filter condition.


Data connector versioning

Data connectors use a draft/live versioning system so you can make edits safely without interrupting the running connector.

  • Each Data connector has a live version and a draft version. Edits are made to the draft without affecting the running live version.

  • When you publish a draft, a new version snapshot is created and becomes the live version. You can add notes at publish time. The previous live version is archived.

  • Each version records a version number, who created it, change notes (if added), and a timestamp.

  • The full history of changes is traceable and you can roll back to any previous version.


Public APIs for Data connectors

Two public APIs (application programming interfaces) give you programmatic access to Data connector configurations and execution results. Both use OAuth (Open Authorization) for authentication. Full reference documentation is available in the Intercom Developer Hub.

How to use the Configuration API

The Configuration API is a set of CRUD (create, read, update, delete) endpoints for programmatically managing Data connectors. Use it to create new connectors, keep connectors in sync with your internal systems, and automate connector management at scale. The table below lists the available endpoints and their purpose.

Method

Endpoint

Purpose

GET

/data_connectors

Returns a paginated list of all Data connectors for the workspace, ordered by most recently updated first.

GET

/data_connectors/:id

Retrieves the full detail of a single Data connector by ID, including configuration, data inputs, response fields, and object mappings.

POST

/data_connectors

Creates a new Data connector in draft state. Configure its URL, headers, data inputs, and other settings, then set it live when ready.

PATCH

/data_connectors/:id

Updates an existing Data connector. Only provided fields are changed. Set state to live or draft to change the connector's state.

DELETE

/data_connectors/:id

Deletes an existing Data connector. The connector must be in draft state and must not be in use by any workflows or AI agents.

Authentication uses OAuth (Open Authorization). Read and write access requires the read_write_data_connectors scope. Read-only access requires the read_workflow_connector_execution_result scope.

How to use the Results API

The Results API gives you programmatic access to execution data for each Data connector. Use it to build custom dashboards, feed alerting systems, or perform deeper analysis than the in-product health dashboard provides.

  • GET /data_connectors/:id/execution_results — retrieves paginated execution logs. Results from the last hour are returned by default. Use start_ts and end_ts to customise the time range. Request/response bodies are excluded by default — use include_bodies=true to include them.

  • GET /data_connectors/:id/execution_results/:result_id — retrieves a single execution result, always including full request/response bodies for deep debugging.

Filtering options include success status, specific error types, and time ranges specified as Unix timestamps (seconds elapsed since 1 January 1970 UTC). Pagination uses a cursor-based model, returning up to 30 results per page. Authentication uses OAuth with the read_workflow_connector_execution_result scope.



Known limitations

The following limitations apply to Data connectors. Where a workaround is available, it is noted below.

  • Fin may not always use a Data connector even if it successfully runs an API request — if other content is judged more relevant to the customer's question, Fin will use that instead. No workaround; review connector naming and description to improve relevance matching.

  • Fin cannot query Intercom custom attributes or event data directly to answer questions. Use a Data connector to expose this data via an external API endpoint instead.

  • Data connectors require AI Answers to be enabled in the workflow step for Fin to use them. AI Answers cannot be enabled in test workspaces, so Data connectors can only be fully tested in a production environment. Use test user profiles in production for safe testing.

  • The Data connector execution webhook is not fired when the connector is triggered as part of a preview conversation.

  • A Data connector can only be deleted via the API when it is in draft state and not referenced by any workflows or AI agents.

  • Emojis are not supported in Data connector names — including one will cause an error when saving.

Note: There is no customer-configurable timeout field. The default timeout is 15 seconds. For Data connectors used within Fin Procedures in eligible workspaces, the timeout is extended to 30 seconds.

Troubleshooting Data connectors

How to use Data connector logs

All response data from Data connectors triggered by Fin is recorded and stored for up to 14 days. To access logs, navigate to Settings > Integrations > Data connectors, click the connector you want to investigate, and select Logs.

Screenshot of the Data connector Logs tab showing a list of execution entries with timestamp, status, request URL, and response code columns.

How to use the Data connector execution webhook

For real-time signals on Data connector success and failure rates, use the Data connector execution webhook. This lets you receive execution events from Intercom and use them to build real-time dashboards, alerts, and SLA (service level agreement) monitoring in your external services.

Notes:

  • You will need to create an app, set up Webhooks and subscribe to the Data connector execution webhook before you can receive any Data connector notifications.

  • The Data connector execution webhook will be skipped if the Data connector is triggered as part of a preview conversation.


💡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?