Skip to main content

Airbyte Intercom Connector for AI platforms

Project description

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_external_user_id>",
    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.

Entity Actions
Contacts List, Get
Conversations List, Get
Companies List, Get
Teams List, Get
Admins List, Get
Tags List, Get
Segments List, 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.36
  • Connector version: 0.1.4
  • Generated with Connector SDK commit SHA: 0f5e1914fa0d7d52de7bc0018afab712184a0847

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.36.tar.gz (133.4 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.36-py3-none-any.whl (155.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for airbyte_agent_intercom-0.1.36.tar.gz
Algorithm Hash digest
SHA256 0bf09e24a0c029af7567a44a7785f32abf8ffb155026ac27fb7e432d5c50be51
MD5 12017f009b6ccf5766222460c1fdb2f7
BLAKE2b-256 aac5c43427f81c329bfec2cb0268a1113ee90dd0d607d231cf65a549ac18ebc4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_intercom-0.1.36-py3-none-any.whl
Algorithm Hash digest
SHA256 a238d5e9b199e81a6e531a94479257a4a1f7062ace8e1409ea364291f01e5501
MD5 700a4df3dfae7b583fff2fb878a16d13
BLAKE2b-256 7e91bca43ec1618e0cc9e086044796c163c2cebb9b6fac854f5aae9010779099

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