-
Notifications
You must be signed in to change notification settings - Fork 2
Add API and Fin capabilities to README #327
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,15 +1,73 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Intercom's REST API OpenAPI Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can probably stick with this https://developers.intercom.com/intercom-api-reference/ out of those to have uniformity throughout 🤔 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| It defines the HTTP interface used to integrate with Intercom’s customer engagement and support platform. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| **Supported API versions:** 2.7 and higher. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## What is OpenAPI? | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| From the [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification): | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| > 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## About the Intercom API | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Using this OpenAPI specification, developers can: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Generate SDKs or client libraries using tools such as [OpenAPI Generator](https://openapi-generator.tech/) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Explore schemas and models for Intercom’s API objects | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Build, test, and validate integrations in a consistent and language-agnostic way | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## 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). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+29
to
+41
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Related Resources | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [Intercom API Reference](https://developers.intercom.com/intercom-api-reference/) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [Developer Documentation](https://www.intercom.com/developers) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [Fin.ai Overview](https://www.intercom.com/fin) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [Official SDKs and Client Libraries](https://github.com/intercom) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - [Intercom Homepage](https://www.intercom.com) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are we no longer encouraging to raise issues if they find any mismatch?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'll add this back in
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To contributing section |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Versioning | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| This specification tracks the current Intercom API version. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| **Last updated:** October 2025. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## About Intercom | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| [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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.