Skip to content

Commit 603860f

Browse files
steve-henrySteve Henry
andauthored
Add API and Fin capabilities to README (#327)
* Add API and Fin capabilities to README * Add back text about raising issues --------- Co-authored-by: Steve Henry <stevehenry@Steves-MacBook-Pro.local>
1 parent ee39121 commit 603860f

File tree

1 file changed

+61
-3
lines changed

1 file changed

+61
-3
lines changed

README.md

Lines changed: 61 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,73 @@
1-
# Intercom's REST API OpenAPI Description
1+
# Intercom REST API OpenAPI Description
22

3-
This repository contains [OpenAPI](https://www.openapis.org/) descriptions for [Intercom's REST API](https://developers.intercom.com/intercom-api-reference/reference/welcome). It covers API versions 2.7 and higher.
3+
This repository contains [OpenAPI](https://www.openapis.org/) descriptions for [Intercom’s REST API](https://developers.intercom.com/intercom-api-reference/reference/welcome).
4+
It defines the HTTP interface used to integrate with Intercom’s customer engagement and support platform.
5+
6+
**Supported API versions:** 2.7 and higher.
7+
8+
---
49

510
## What is OpenAPI?
611

712
From the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification):
813

914
> The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.
1015
16+
---
17+
18+
## About the Intercom API
19+
20+
The [Intercom API](https://developers.intercom.com/intercom-api-reference/) provides programmatic access to Intercom’s platform, including endpoints for messages, conversations, contacts, companies, and automation.
21+
22+
Using this OpenAPI specification, developers can:
23+
- Generate SDKs or client libraries using tools such as [OpenAPI Generator](https://openapi-generator.tech/)
24+
- Explore schemas and models for Intercom’s API objects
25+
- Build, test, and validate integrations in a consistent and language-agnostic way
26+
27+
---
28+
29+
## Fin by Intercom
30+
31+
The Intercom API can empower [Fin.ai](https://www.intercom.com/fin), Intercom’s AI assistant for customer support and automation.
32+
You can use the API to create and edit the articles that Fin uses when answering customers' questions.
33+
The API can also set data like conversation and user attributes to be referenced by Fin Guidance or control the flow of automations like Fin Procedures.
34+
35+
**Fin Procedures**
36+
Define multi-step actions that Fin can execute through the API to handle structured or recurring workflows.
37+
Learn more on the [Fin Procedures overview](https://fin.ai/procedures) or read the [Fin Procedures help guide](https://fin.ai/help/en/articles/12628343-fin-procedures-explained).
38+
39+
**Fin Voice**
40+
Build voice-based customer experiences powered by Fin’s conversational AI.
41+
Learn more on the [Fin Voice product page](https://fin.ai/voice) or see [Fin Voice setup instructions](https://www.intercom.com/help/en/articles/10697275-deploy-fin-ai-agent-over-phone).
42+
43+
---
44+
45+
## Related Resources
46+
47+
- [Intercom API Reference](https://developers.intercom.com/intercom-api-reference/)
48+
- [Developer Documentation](https://www.intercom.com/developers)
49+
- [Fin.ai Overview](https://www.intercom.com/fin)
50+
- [Official SDKs and Client Libraries](https://github.com/intercom)
51+
- [Intercom Homepage](https://www.intercom.com)
52+
53+
---
54+
1155
## Contributing
1256

13-
Because this description is automatically generated from our internal codebase, we don't currently accept pull requests that directly modify the description. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
57+
Because this description is automatically generated from Intercom’s internal codebase, so we do not currently accept direct pull requests that directly modify the specification.
58+
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
1459

1560
If you've identified a mismatch between the Intercom API's behavior and these descriptions, or found an issue with the format of a schema, [please open an issue.](https://github.com/intercom/Intercom-OpenAPI/issues/new?template=schema-inaccuracy.md)
61+
62+
---
63+
64+
## Versioning
65+
66+
This specification tracks the current Intercom API version.
67+
**Last updated:** October 2025.
68+
69+
---
70+
71+
## About Intercom
72+
73+
[Intercom](https://www.intercom.com) is a platform for AI-powered customer communication, combining messaging, automation, and human support to help businesses connect with their customers at scale.

0 commit comments

Comments
 (0)