Add API and Fin capabilities to README #327
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
VarshSuresh
reviewed
Nov 10, 2025
| # Intercom REST API OpenAPI Description | ||
|
|
||
| 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. | ||
| This repository contains [OpenAPI](https://www.openapis.org/) descriptions for [Intercom’s REST API](https://developers.intercom.com/intercom-api-reference/reference/welcome). |
Contributor
There was a problem hiding this comment.
Nit: This link redirects to the introduction page: https://developers.intercom.com/docs/references/introduction.
So does this https://developers.intercom.com/intercom-api-reference/
Contributor
Author
There was a problem hiding this comment.
I think that's the entry page for the API reference. Is there another that would be better?
Contributor
There was a problem hiding this comment.
We can probably stick with this https://developers.intercom.com/intercom-api-reference/ out of those to have uniformity throughout 🤔
VarshSuresh
reviewed
Nov 10, 2025
|
|
||
| ## About Intercom | ||
|
|
||
| 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) |
Contributor
There was a problem hiding this comment.
Are we no longer encouraging to raise issues if they find any mismatch?
Contributor
Author
There was a problem hiding this comment.
I'll add this back in
Contributor
Author
There was a problem hiding this comment.
To contributing section
levindixon
approved these changes
Nov 10, 2025
Contributor
levindixon
left a comment
levindixon
left a comment
There was a problem hiding this comment.
All the comments can be considered non-blocking, we should fix the minor error in the contributing section.
| ## Contributing | ||
|
|
||
| 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. | ||
| 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. |
Contributor
There was a problem hiding this comment.
Suggested change
| 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. | |
| This description is automatically generated from Intercom’s internal codebase, so we don’t accept pull requests that modify the specification directly. |
| @@ -1,15 +1,72 @@ | |||
| # Intercom's REST API OpenAPI Description | |||
| # Intercom REST API OpenAPI Description | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Intercom REST API OpenAPI Description | |
| # OpenAPI description for Intercom’s REST API |
|
|
||
| **Supported API versions:** 2.7 and higher. | ||
|
|
||
| --- |
Contributor
There was a problem hiding this comment.
Since H2s render with an underline already you might be good to omit these heavier section dividers.
Comment on lines
+29
to
+41
| ## Fin by Intercom | ||
|
|
||
| The Intercom API can empower [Fin.ai](https://www.intercom.com/fin), Intercom’s AI assistant for customer support and automation. | ||
| You can use the API to create and edit the articles that Fin uses when answering customers' questions. | ||
| 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. | ||
|
|
||
| **Fin Procedures** | ||
| Define multi-step actions that Fin can execute through the API to handle structured or recurring workflows. | ||
| 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). | ||
|
|
||
| **Fin Voice** | ||
| Build voice-based customer experiences powered by Fin’s conversational AI. | ||
| 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). |
Contributor
There was a problem hiding this comment.
Suggested change
| ## Fin by Intercom | |
| The Intercom API can empower [Fin.ai](https://www.intercom.com/fin), Intercom’s AI assistant for customer support and automation. | |
| You can use the API to create and edit the articles that Fin uses when answering customers' questions. | |
| 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. | |
| **Fin Procedures** | |
| Define multi-step actions that Fin can execute through the API to handle structured or recurring workflows. | |
| 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). | |
| **Fin Voice** | |
| Build voice-based customer experiences powered by Fin’s conversational AI. | |
| 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). | |
| ## Fin AI Agent | |
| Use the Intercom API to power Fin, the AI Agent for customer service, with the content and context it needs to resolve customer queries and run automations. | |
| You can: | |
| - Create and update the help center articles Fin uses to resolve customer queries | |
| - Set conversation and user attributes for Fin Guidance | |
| - Trigger or control automations such as Fin Procedures | |
| ### Fin Procedures | |
| Define multi-step actions that Fin can execute via the API to handle structured or recurring workflows. | |
| Learn more: [Fin Procedures overview](https://fin.ai/procedures). Read: [Fin Procedures help guide](https://fin.ai/help/en/articles/12628343-fin-procedures-explained). | |
| ### Fin Voice | |
| Build voice-based customer experiences powered by Fin’s conversational AI. | |
| Learn more: [Fin Voice product page](https://fin.ai/voice). Set up: [Deploy Fin AI Agent over the phone](https://www.intercom.com/help/en/articles/10697275-deploy-fin-ai-agent-over-phone). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding more details on API capabilities and how they can empower Fin to the readme