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.describe
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.describe
async def intercom_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

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.27
  • Connector version: 0.1.1
  • Generated with Connector SDK commit SHA: 416466da4970ae5fd6c7f2c658a68e047e51efd9

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.27.tar.gz (114.6 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.27-py3-none-any.whl (139.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: airbyte_agent_intercom-0.1.27.tar.gz
  • Upload date:
  • Size: 114.6 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.27.tar.gz
Algorithm Hash digest
SHA256 0d8752b5567616bcd292d5a1014eca087f9ca36baf77c65643847d30f8a2590e
MD5 ce3113ddc1ae8cd9f2c2a1a45ee748f8
BLAKE2b-256 5b95581e54166d7b2a0596c2566b0b66c3ac98b50b75d4bc35313b0efbf55ac6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_intercom-0.1.27-py3-none-any.whl
Algorithm Hash digest
SHA256 f94a2a3ca9f9b21edd91e882d92af4cb40b715bd4d9121f6b61fd41b24905c2b
MD5 757aa317179e689c55d1dcacbbe55939
BLAKE2b-256 08ab2cf7d4042224a4cd51bb25b854734d98ad1be0b3ff00bb3c897bd9ef0be5

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