Skip to content

Update Custom Channel Event endpoints docs #261

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
merged 1 commit into from
May 20, 2025
+20 −20
Merged

Update Custom Channel Event endpoints docs #261

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
20 changes: 10 additions & 10 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7523,7 +7523,7 @@ paths:
summary: Bad request
value:
ticket_type_id: '54'
"/custom_channel_events/new_conversation":
"/custom_channel_events/notify_new_conversation":
post:
summary: Notify Intercom of a new conversation created in a custom channel
tags:
Expand Down Expand Up @@ -7566,7 +7566,7 @@ paths:
$ref: '#/components/responses/ObjectNotFound'
'422':
$ref: '#/components/responses/ValidationError'
/custom_channel_events/message:
"/custom_channel_events/notify_new_message":
post:
summary: Notify Intercom of a new message in a custom channel conversation
tags:
Expand Down Expand Up @@ -7618,12 +7618,12 @@ paths:
$ref: '#/components/responses/ObjectNotFound'
'422':
$ref: '#/components/responses/ValidationError'
/custom_channel_events/quick_reply_response:
"/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: notifyQuickReplyResponse
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".
Expand All @@ -7642,11 +7642,11 @@ paths:
- $ref: '#/components/schemas/custom_channel_base_event'
- type: object
properties:
quick_reply_option_uuid:
quick_reply_option_id:
type: string
description: UUID of the selected quick reply option.
description: Id of the selected quick reply option.
required:
- quick_reply_option_uuid
- quick_reply_option_id
examples:
example-1:
summary: Example request
Expand All @@ -7658,7 +7658,7 @@ paths:
external_id: "user_003"
name: "Alice Example"
email: "alice@example.com"
quick_reply_option_uuid: "b7e6a2c4-8f3a-4d2e-9c1a-2f6b7e8a9c3d"
quick_reply_option_id: "1234"
responses:
'204':
description: Successfully notified Intercom of the quick reply response.
Expand All @@ -7670,12 +7670,12 @@ paths:
$ref: '#/components/responses/ObjectNotFound'
'422':
$ref: '#/components/responses/ValidationError'
/custom_channel_events/attribute_collector_response:
"/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: notifyAttributeCollectorResponse
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".
Expand Down
20 changes: 10 additions & 10 deletions fern/openapi-overrides.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,30 +442,30 @@ paths:
- conversations
x-fern-sdk-method-name: redactConversationPart
x-fern-request-name: RedactConversationPartRequest
/custom_channel_events/attribute_collector_response:
/custom_channel_events/notify_attribute_collected:
post:
x-fern-sdk-group-name:
- customChannelEvents
x-fern-sdk-method-name: notifyAttributeCollectorResponse
x-fern-request-name: NotifyAttributeCollectorResponseRequest
/custom_channel_events/message:
x-fern-sdk-method-name: notifyAttributeCollected
x-fern-request-name: NotifyAttributeCollectedRequest
/custom_channel_events/notify_new_message:
post:
x-fern-sdk-group-name:
- customChannelEvents
x-fern-sdk-method-name: notifyMessage
x-fern-request-name: NotifyMessageRequest
/custom_channel_events/new_conversation:
x-fern-sdk-method-name: notifyNewMessage
x-fern-request-name: NotifyNewMessageRequest
/custom_channel_events/notify_new_conversation:
post:
x-fern-sdk-group-name:
- customChannelEvents
x-fern-sdk-method-name: notifyNewConversation
x-fern-request-name: NotifyNewConversationRequest
/custom_channel_events/quick_reply_response:
/custom_channel_events/notify_quick_reply_selected:
post:
x-fern-sdk-group-name:
- customChannelEvents
x-fern-sdk-method-name: notifyQuickReplyResponse
x-fern-request-name: NotifyQuickReplyResponseRequest
x-fern-sdk-method-name: notifyQuickReplySelected
x-fern-request-name: NotifyQuickReplySelectedRequest
/data_attributes:
get:
x-fern-sdk-group-name:
Expand Down