Skip to content

Update Fin over API availability documentation #277

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.

Sign up for GitHub

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

Merged
auroralimin merged 1 commit into from
Jul 16, 2025
Merged

Update Fin over API availability documentation #277

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7813,7 +7813,7 @@ paths:
operationId: notifyNewConversation
description: |
Notifies Intercom that a new conversation was created in your custom channel/platform. This triggers conversation creation and workflow automations within Intercom for your custom channel integration.
> **Note:** This endpoint is restricted to customers with access to the closed beta for "Fin over API".
> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.
parameters:
- name: Intercom-Version
in: header
Expand Down Expand Up @@ -7856,7 +7856,7 @@ paths:
operationId: notifyNewMessage
description: |
Notifies Intercom that a new message was sent in a conversation on your custom channel/platform. This allows Intercom to process the message and trigger any relevant workflow automations.
> **Note:** This endpoint is restricted to customers with access to the closed beta for "Fin over API".
> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.
parameters:
- name: Intercom-Version
in: header
Expand Down Expand Up @@ -7908,7 +7908,7 @@ paths:
operationId: notifyQuickReplySelected
description: |
Notifies Intercom that a user selected a quick reply option in your custom channel/platform. This allows Intercom to process the response and trigger any relevant workflow automations.
> **Note:** This endpoint is restricted to customers with access to the closed beta for "Fin over API".
> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.
parameters:
- name: Intercom-Version
in: header
Expand Down Expand Up @@ -7960,7 +7960,7 @@ paths:
operationId: notifyAttributeCollected
description: |
Notifies Intercom that a user provided a response to an attribute collector in your custom channel/platform. This allows Intercom to process the attribute and trigger any relevant workflow automations.
> **Note:** This endpoint is restricted to customers with access to the closed beta for "Fin over API".
> **Note:** This endpoint is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.
parameters:
- name: Intercom-Version
in: header
Expand Down Expand Up @@ -18659,7 +18659,7 @@ components:
example: Customer
nullable: true
intercom_version_unstable:
description: Unstable Intercom API version. Used for closed beta endpoints.
description: Unstable Intercom API version. Used for closed beta endpoints or other features under managed availability.
type: string
example: unstable
default: unstable
Expand Down Expand Up @@ -21367,11 +21367,11 @@ tags:
url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation
- name: Custom Channel Events
description: |
With the **closed beta** "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.
With the "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.

Intercom treats your integration like any other Intercom channel, allowing your application and Intercom to exchange events seamlessly. This makes it possible, for example, for your users to interact with Fin directly within your own application’s UI.

> **Note:** If you are interested in joining our closed beta and have a use case to integrate with "Fin over API", please reach out to your account manager or our support team for further information.
> **Note:** "Fin over API" is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.
- name: Custom Object Instances
description: |
Everything about your Custom Object instances.
Expand Down