Skip to content

Commit e176aea

Browse files
authored
Update custom channel event endpoint success responses (#266)
1 parent f6aa883 commit e176aea

File tree

1 file changed

+41
-8
lines changed

1 file changed

+41
-8
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7556,8 +7556,8 @@ paths:
75567556
name: "Jane Doe"
75577557
email: "jane.doe@example.com"
75587558
responses:
7559-
'204':
7560-
description: Successfully notified Intercom of the new conversation.
7559+
'200':
7560+
$ref: '#/components/responses/CustomChannelNotificationSuccess'
75617561
'400':
75627562
$ref: '#/components/responses/BadRequest'
75637563
'401':
@@ -7608,8 +7608,8 @@ paths:
76087608
email: "john.smith@example.com"
76097609
body: "Hello, I need help with my order."
76107610
responses:
7611-
'204':
7612-
description: Successfully notified Intercom of the new message.
7611+
'200':
7612+
$ref: '#/components/responses/CustomChannelNotificationSuccess'
76137613
'400':
76147614
$ref: '#/components/responses/BadRequest'
76157615
'401':
@@ -7660,8 +7660,8 @@ paths:
76607660
email: "alice@example.com"
76617661
quick_reply_option_id: "1234"
76627662
responses:
7663-
'204':
7664-
description: Successfully notified Intercom of the quick reply response.
7663+
'200':
7664+
$ref: '#/components/responses/CustomChannelNotificationSuccess'
76657665
'400':
76667666
$ref: '#/components/responses/BadRequest'
76677667
'401':
@@ -7713,8 +7713,8 @@ paths:
77137713
id: "shipping_address"
77147714
value: "123 Main St, Springfield"
77157715
responses:
7716-
'204':
7717-
description: Successfully notified Intercom of the attribute collector response.
7716+
'200':
7717+
$ref: '#/components/responses/CustomChannelNotificationSuccess'
77187718
'400':
77197719
$ref: '#/components/responses/BadRequest'
77207720
'401':
@@ -17766,6 +17766,26 @@ components:
1776617766
type: string
1776717767
format: email
1776817768
description: Email address of the contact.
17769+
custom_channel_notification_response:
17770+
type: object
17771+
required:
17772+
- external_conversation_id
17773+
- conversation_id
17774+
- external_contact_id
17775+
- contact_id
17776+
properties:
17777+
external_conversation_id:
17778+
type: string
17779+
description: The external conversation ID provided in the notification request
17780+
conversation_id:
17781+
type: string
17782+
description: The Intercom conversation ID mapped to the external conversation ID
17783+
external_contact_id:
17784+
type: string
17785+
description: The external contact ID provided in the notification request
17786+
contact_id:
17787+
type: string
17788+
description: The Intercom contact ID mapped to the external contact ID
1776917789
custom_action_finished:
1777017790
title: Part type - custom_action_finished
1777117791
type: object
@@ -20901,6 +20921,19 @@ components:
2090120921
message: Contact not found or could not be created
2090220922
schema:
2090320923
"$ref": "#/components/schemas/error"
20924+
CustomChannelNotificationSuccess:
20925+
description: Successfully notified Intercom
20926+
content:
20927+
application/json:
20928+
schema:
20929+
$ref: '#/components/schemas/custom_channel_notification_response'
20930+
examples:
20931+
NotificationSuccess:
20932+
value:
20933+
external_conversation_id: "customer_conversation_id_12"
20934+
conversation_id: "intercom_conversation_id_34"
20935+
external_contact_id: "customer_contact_id_56"
20936+
contact_id: "intercom_contact_id_79"
2090420937
servers:
2090520938
- url: https://api.intercom.io
2090620939
description: The production API server

0 commit comments

Comments
 (0)