Skip to content

Commit e4d91b5

Browse files
committed
Update Custom Channel Event endpoints docs
Align the documentation with the latest contract changes, that were mainly done to make it more clear that these endpoints are about event notifications.
1 parent b6aeb65 commit e4d91b5

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7523,7 +7523,7 @@ paths:
75237523
summary: Bad request
75247524
value:
75257525
ticket_type_id: '54'
7526-
"/custom_channel_events/new_conversation":
7526+
"/custom_channel_events/notify_new_conversation":
75277527
post:
75287528
summary: Notify Intercom of a new conversation created in a custom channel
75297529
tags:
@@ -7566,7 +7566,7 @@ paths:
75667566
$ref: '#/components/responses/ObjectNotFound'
75677567
'422':
75687568
$ref: '#/components/responses/ValidationError'
7569-
/custom_channel_events/message:
7569+
"/custom_channel_events/notify_new_message":
75707570
post:
75717571
summary: Notify Intercom of a new message in a custom channel conversation
75727572
tags:
@@ -7618,12 +7618,12 @@ paths:
76187618
$ref: '#/components/responses/ObjectNotFound'
76197619
'422':
76207620
$ref: '#/components/responses/ValidationError'
7621-
/custom_channel_events/quick_reply_response:
7621+
"/custom_channel_events/notify_quick_reply_selected":
76227622
post:
76237623
summary: Notify Intercom of a quick reply response in a custom channel conversation
76247624
tags:
76257625
- Custom Channel Events
7626-
operationId: notifyQuickReplyResponse
7626+
operationId: notifyQuickReplySelected
76277627
description: |
76287628
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.
76297629
> **Note:** This endpoint is restricted to customers with access to the closed beta for "Fin over API".
@@ -7642,11 +7642,11 @@ paths:
76427642
- $ref: '#/components/schemas/custom_channel_base_event'
76437643
- type: object
76447644
properties:
7645-
quick_reply_option_uuid:
7645+
quick_reply_option_id:
76467646
type: string
7647-
description: UUID of the selected quick reply option.
7647+
description: Id of the selected quick reply option.
76487648
required:
7649-
- quick_reply_option_uuid
7649+
- quick_reply_option_id
76507650
examples:
76517651
example-1:
76527652
summary: Example request
@@ -7658,7 +7658,7 @@ paths:
76587658
external_id: "user_003"
76597659
name: "Alice Example"
76607660
email: "alice@example.com"
7661-
quick_reply_option_uuid: "b7e6a2c4-8f3a-4d2e-9c1a-2f6b7e8a9c3d"
7661+
quick_reply_option_id: "1234"
76627662
responses:
76637663
'204':
76647664
description: Successfully notified Intercom of the quick reply response.
@@ -7670,12 +7670,12 @@ paths:
76707670
$ref: '#/components/responses/ObjectNotFound'
76717671
'422':
76727672
$ref: '#/components/responses/ValidationError'
7673-
/custom_channel_events/attribute_collector_response:
7673+
"/custom_channel_events/notify_attribute_collected":
76747674
post:
76757675
summary: Notify Intercom of an attribute collector response in a custom channel conversation
76767676
tags:
76777677
- Custom Channel Events
7678-
operationId: notifyAttributeCollectorResponse
7678+
operationId: notifyAttributeCollected
76797679
description: |
76807680
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.
76817681
> **Note:** This endpoint is restricted to customers with access to the closed beta for "Fin over API".

fern/openapi-overrides.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -442,30 +442,30 @@ paths:
442442
- conversations
443443
x-fern-sdk-method-name: redactConversationPart
444444
x-fern-request-name: RedactConversationPartRequest
445-
/custom_channel_events/attribute_collector_response:
445+
/custom_channel_events/notify_attribute_collected:
446446
post:
447447
x-fern-sdk-group-name:
448448
- customChannelEvents
449-
x-fern-sdk-method-name: notifyAttributeCollectorResponse
450-
x-fern-request-name: NotifyAttributeCollectorResponseRequest
451-
/custom_channel_events/message:
449+
x-fern-sdk-method-name: notifyAttributeCollected
450+
x-fern-request-name: NotifyAttributeCollectedRequest
451+
/custom_channel_events/notify_new_message:
452452
post:
453453
x-fern-sdk-group-name:
454454
- customChannelEvents
455-
x-fern-sdk-method-name: notifyMessage
456-
x-fern-request-name: NotifyMessageRequest
457-
/custom_channel_events/new_conversation:
455+
x-fern-sdk-method-name: notifyNewMessage
456+
x-fern-request-name: NotifyNewMessageRequest
457+
/custom_channel_events/notify_new_conversation:
458458
post:
459459
x-fern-sdk-group-name:
460460
- customChannelEvents
461461
x-fern-sdk-method-name: notifyNewConversation
462462
x-fern-request-name: NotifyNewConversationRequest
463-
/custom_channel_events/quick_reply_response:
463+
/custom_channel_events/notify_quick_reply_selected:
464464
post:
465465
x-fern-sdk-group-name:
466466
- customChannelEvents
467-
x-fern-sdk-method-name: notifyQuickReplyResponse
468-
x-fern-request-name: NotifyQuickReplyResponseRequest
467+
x-fern-sdk-method-name: notifyQuickReplySelected
468+
x-fern-request-name: NotifyQuickReplySelectedRequest
469469
/data_attributes:
470470
get:
471471
x-fern-sdk-group-name:

0 commit comments

Comments
 (0)