Skip to content

Remove Custom Channel Events API from all spec versions #460

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
rahulgdsouza merged 1 commit into from
Apr 17, 2026
Merged

Remove Custom Channel Events API from all spec versions #460

Show file tree
Hide file tree
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
290 changes: 0 additions & 290 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10266,206 +10266,6 @@ paths:
message: Requested resource is not available in current API version.
schema:
"$ref": "#/components/schemas/error"
"/custom_channel_events/notify_new_conversation":
post:
summary: Notify Intercom of a new conversation created in a custom channel
tags:
- Custom Channel Events
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 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
required: true
schema:
$ref: '#/components/schemas/intercom_version_preview'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/custom_channel_base_event'
examples:
example-1:
summary: Example request
value:
event_id: "evt_12345"
external_conversation_id: "conv_67890"
contact:
type: "user"
external_id: "user_001"
name: "Jane Doe"
email: "jane.doe@example.com"
responses:
'200':
$ref: '#/components/responses/CustomChannelNotificationSuccess'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: "#/components/responses/Unauthorized"
'404':
$ref: '#/components/responses/ObjectNotFound'
'422':
$ref: '#/components/responses/ValidationError'
"/custom_channel_events/notify_new_message":
post:
summary: Notify Intercom of a new message in a custom channel conversation
tags:
- Custom Channel Events
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 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
required: true
schema:
$ref: '#/components/schemas/intercom_version_preview'
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/custom_channel_base_event'
- type: object
properties:
body:
type: string
description: The message content sent by the user.
required:
- body
examples:
example-1:
summary: Example request
value:
event_id: "evt_54321"
external_conversation_id: "conv_98765"
contact:
type: "user"
external_id: "user_002"
name: "John Smith"
email: "john.smith@example.com"
body: "Hello, I need help with my order."
responses:
'200':
$ref: '#/components/responses/CustomChannelNotificationSuccess'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: "#/components/responses/Unauthorized"
'404':
$ref: '#/components/responses/ObjectNotFound'
'422':
$ref: '#/components/responses/ValidationError'
"/custom_channel_events/notify_quick_reply_selected":
post:
summary: Notify Intercom of a quick reply response in a custom channel conversation
tags:
- Custom Channel Events
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 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
required: true
schema:
$ref: '#/components/schemas/intercom_version_preview'
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/custom_channel_base_event'
- type: object
properties:
quick_reply_option_id:
type: string
description: Id of the selected quick reply option.
required:
- quick_reply_option_id
examples:
example-1:
summary: Example request
value:
event_id: "evt_67890"
external_conversation_id: "conv_13579"
contact:
type: "user"
external_id: "user_003"
name: "Alice Example"
email: "alice@example.com"
quick_reply_option_id: "1234"
responses:
'200':
$ref: '#/components/responses/CustomChannelNotificationSuccess'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: "#/components/responses/Unauthorized"
'404':
$ref: '#/components/responses/ObjectNotFound'
'422':
$ref: '#/components/responses/ValidationError'
"/custom_channel_events/notify_attribute_collected":
post:
summary: Notify Intercom of an attribute collector response in a custom channel conversation
tags:
- Custom Channel Events
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 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
required: true
schema:
$ref: '#/components/schemas/intercom_version_preview'
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/custom_channel_base_event'
- type: object
properties:
attribute:
$ref: '#/components/schemas/custom_channel_attribute'
required:
- attribute
examples:
example-1:
summary: Example request
value:
event_id: "evt_24680"
external_conversation_id: "conv_11223"
contact:
type: "user"
external_id: "user_004"
name: "Bob Example"
email: "bob@example.com"
attribute:
id: "shipping_address"
value: "123 Main St, Springfield"
responses:
'200':
$ref: '#/components/responses/CustomChannelNotificationSuccess'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: "#/components/responses/Unauthorized"
'404':
$ref: '#/components/responses/ObjectNotFound'
'422':
$ref: '#/components/responses/ValidationError'
"/custom_object_instances/{custom_object_type_identifier}":
parameters:
- name: custom_object_type_identifier
Expand Down Expand Up @@ -24860,76 +24660,6 @@ components:
type: string
description: Name of the action
example: Jira Create Issue
custom_channel_attribute:
title: Custom Channel - Attribute
type: object
required:
- id
- value
properties:
id:
type: string
description: Identifier for the attribute being collected.
value:
type: string
description: Value provided by the user for the attribute.
custom_channel_base_event:
title: Custom Channel - Base Event
type: object
properties:
event_id:
type: string
description: Unique identifier for the event.
external_conversation_id:
type: string
description: Identifier for the conversation in your application.
contact:
$ref: '#/components/schemas/custom_channel_contact'
required:
- event_id
- external_conversation_id
- contact
custom_channel_contact:
title: Custom Channel - Simplified Contact
type: object
required:
- type
- external_id
properties:
type:
type: string
enum: [user, lead]
description: Type of contact, must be "user" or "lead".
external_id:
type: string
description: External identifier for the contact. Intercom will take care of the mapping of your external_id with our internal ones so you don't have to worry about it.
name:
type: string
description: Name of the contact. Required for user type.
email:
type: string
format: email
description: Email address of the contact. Required for user type.
custom_channel_notification_response:
type: object
required:
- external_conversation_id
- conversation_id
- external_contact_id
- contact_id
properties:
external_conversation_id:
type: string
description: The external conversation ID provided in the notification request
conversation_id:
type: string
description: The Intercom conversation ID mapped to the external conversation ID
external_contact_id:
type: string
description: The external contact ID provided in the notification request
contact_id:
type: string
description: The Intercom contact ID mapped to the external contact ID
custom_action_finished:
title: Part type - custom_action_finished
type: object
Expand Down Expand Up @@ -29404,19 +29134,6 @@ components:
message: Contact not found or could not be created
schema:
"$ref": "#/components/schemas/error"
CustomChannelNotificationSuccess:
description: Successfully notified Intercom
content:
application/json:
schema:
$ref: '#/components/schemas/custom_channel_notification_response'
examples:
NotificationSuccess:
value:
external_conversation_id: "customer_conversation_id_12"
conversation_id: "intercom_conversation_id_34"
external_contact_id: "customer_contact_id_56"
contact_id: "intercom_contact_id_79"
servers:
- url: https://api.intercom.io
description: The production API server
Expand Down Expand Up @@ -29463,13 +29180,6 @@ tags:
externalDocs:
description: What is a conversation?
url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation
- name: Custom Channel Events
description: |
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:** "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
Loading
Loading