Skip to main content

Airbyte Intercom Connector for AI platforms

Project description

Intercom

The Intercom agent connector is a Python package that equips AI agents to interact with Intercom through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

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

Example questions

The Intercom connector is optimized to handle prompts like these.

  • List all contacts in my Intercom workspace
  • 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
  • Show me all customer segments
  • Show me details for a recent contact
  • Show me details for a recent company
  • Show me details for a recent conversation
  • Create a new lead contact named 'Jane Smith' with email jane@example.com
  • Create an internal article titled 'Onboarding Guide' with instructions for new team members
  • Create a company named 'Acme Corp' with company_id 'acme-001'
  • Create a tag named 'VIP Customer'
  • Update the name of contact {id} to 'John Updated'
  • Add a note to contact {id} saying 'Followed up on support request'
  • Show me conversations from the last week
  • List conversations assigned to team {team_id}
  • Show me open conversations

Unsupported questions

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

  • Send a message to a customer
  • Delete a conversation
  • Delete a contact
  • Delete a company
  • Assign a conversation to an admin

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. If your Airbyte client can access multiple organizations, also set organization_id.

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, AirbyteAuthConfig

connector = IntercomConnector(
    auth_config=AirbyteAuthConfig(
        customer_name="<your_customer_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        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 {})

Full documentation

Entities and actions

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

Entity Actions
Contacts List, Create, Get, Update, Search
Conversations List, Get, Search
Companies List, Create, Get, Update, Search
Teams List, Get, Search
Admins List, Get
Tags List, Create, Get
Notes Create
Segments List, Get
Internal Articles Create

Authentication

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

Intercom API docs

See the official Intercom API reference.

Version information

  • Package version: 0.1.95
  • Connector version: 0.1.9
  • Generated with Connector SDK commit SHA: fbc0bacdabf9b1de67621333cd97edee9c444de4
  • Changelog: View changelog

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_intercom-0.1.95.tar.gz (180.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airbyte_agent_intercom-0.1.95-py3-none-any.whl (205.1 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_agent_intercom-0.1.95.tar.gz.

File metadata

  • Download URL: airbyte_agent_intercom-0.1.95.tar.gz
  • Upload date:
  • Size: 180.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for airbyte_agent_intercom-0.1.95.tar.gz
Algorithm Hash digest
SHA256 a6392aab0a8fe52b604002dca1211cd1350431976abf93477aeb61ae427296e4
MD5 b0b7620021fb50fa26d056ea7375cb7e
BLAKE2b-256 c22f1791284234d1944f9f355e2519721d36a09e4fd5b164737f60578d4577d0

See more details on using hashes here.

File details

Details for the file airbyte_agent_intercom-0.1.95-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_intercom-0.1.95-py3-none-any.whl
Algorithm Hash digest
SHA256 8cc7a751d3d469ce4ef59fecc0106a9c5955e03e76647ad7c18bcb24e406611a
MD5 28fdaf3e36397a96be819d33e2fb48b6
BLAKE2b-256 2533e1e7dfe6f713be1377daa699d31677e72a7866cb7ff37b6ac0f93aedec84

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page