The Intercom Python library provides convenient access to the Intercom API from Python.

pip install python-intercom

A full reference for this library is available here.

Instantiate and use the client with the following:

fromintercomimportIntercomclient=Intercom( token="YOUR_TOKEN", ) client.articles.create( title="Thanks for everything", description="Description of the Article", body="Body of the Article", author_id=1295, state="published", )

The SDK also exports an async client so that you can make non-blocking calls to our API.

importasynciofromintercomimportAsyncIntercomclient=AsyncIntercom( token="YOUR_TOKEN", ) asyncdefmain() ->None: awaitclient.articles.create( title="Thanks for everything", description="Description of the Article", body="Body of the Article", author_id=1295, state="published", ) asyncio.run(main())

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

fromintercom.core.api_errorimportApiErrortry: client.articles.create(...) exceptApiErrorase: print(e.status_code) print(e.body)

Paginated requests will return a SyncPager or AsyncPager, which can be used as generators for the underlying object.

fromintercomimportIntercomclient=Intercom( token="YOUR_TOKEN", ) response=client.articles.list() foriteminresponse: yielditem# alternatively, you can paginate page-by-pageforpageinresponse.iter_pages(): yieldpage

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

fromintercomimportIntercomclient=Intercom( ..., ) response=client.articles.with_raw_response.create(...) print(response.headers) # access the response headersprint(response.data) # access the underlying objectpager=client.articles.list(...) print(pager.response.headers) # access the response headers for the first pageforiteminpager: print(item) # access the underlying object(s)forpageinpager.iter_pages(): print(page.response.headers) # access the response headers for each pageforiteminpage: print(item) # access the underlying object(s)

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retryable when any of the following HTTP status codes is returned:

• 408 (Timeout)
• 429 (Too Many Requests)
• 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior.

client.articles.create(..., request_options={"max_retries": 1 })

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

fromintercomimportIntercomclient=Intercom( ..., timeout=20.0, ) # Override timeout for a specific methodclient.articles.create(..., request_options={"timeout_in_seconds": 1 })

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

importhttpxfromintercomimportIntercomclient=Intercom( ..., httpx_client=httpx.Client( proxies="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0"), ), )

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!