Skip to main content

Intercom agent connector

Intercom is a customer messaging platform that enables businesses to communicate with customers through chat, email, and in-app messaging. This connector provides read-only access to core Intercom entities including contacts, conversations, companies, teams, admins, tags, and segments for customer support analytics and insights.

Example questions

The Intercom connector is optimized to handle prompts like these.

  • List all contacts in my Intercom workspace
  • Show me conversations from the last week
  • List all companies in Intercom
  • What teams are configured in my workspace?
  • Show me all admins in my Intercom account
  • List all tags used in Intercom
  • Get details for contact {contact_id}
  • Show me all customer segments
  • Get company details for {company_id}
  • List conversations assigned to team {team_id}
  • Show me open conversations
  • Get conversation details for {conversation_id}

Unsupported questions

The Intercom connector isn't currently able to handle prompts like these.

  • Create a new contact in Intercom
  • Send a message to a customer
  • Delete a conversation
  • Update company information
  • Assign a conversation to an admin
  • Create a new tag

Installation

uv pip install airbyte-agent-intercom

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

from airbyte_agent_intercom import IntercomConnector
from airbyte_agent_intercom.models import IntercomAuthConfig

connector = IntercomConnector(
auth_config=IntercomAuthConfig(
access_token="<Your Intercom API Access Token>"
)
)

@agent.tool_plain # assumes you're using Pydantic AI
@IntercomConnector.tool_utils
async def intercom_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_intercom import IntercomConnector

connector = IntercomConnector(
external_user_id="<your-scoped-token>",
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)

@agent.tool_plain # assumes you're using Pydantic AI
@IntercomConnector.tool_utils
async def intercom_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})

Replication Configuration

This connector supports replication configuration for MULTI mode sources. See the full reference documentation for details on available options like start_date.

Full documentation

This connector supports the following entities and actions.

EntityActions
ContactsList, Get
ConversationsList, Get
CompaniesList, Get
TeamsList, Get
AdminsList, Get
TagsList, Get
SegmentsList, Get

For all authentication options, see the connector's authentication documentation.

For detailed documentation on available actions and parameters, see this connector's full reference documentation.

For the service's official API docs, see the Intercom API reference.

Version information

  • Package version: 0.1.30
  • Connector version: 0.1.3
  • Generated with Connector SDK commit SHA: 609c1d86c76b36ff699b57123a5a8c2050d958c3