Skip to content

Commit b4e605a

Browse files
rahulgdsouzaclaude
andcommitted
Add intercom_conversation_id to Fin Agent API response schemas
The intercom_conversation_id field has been globally enabled in the Fin Agent API but was missing from the OpenAPI specs. This adds it to the /fin/start and /fin/reply response schemas (both examples and properties) in versions 2.14, 2.15, and 0 (unstable). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 43bfa05 commit b4e605a

3 files changed

Lines changed: 36 additions & 0 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2054,13 +2054,15 @@ paths:
20542054
Successful response:
20552055
value:
20562056
conversation_id: ext-123
2057+
intercom_conversation_id: '5678'
20572058
user_id: user-456
20582059
status: thinking
20592060
created_at_ms: '2025-01-24T10:00:00.123Z'
20602061
sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m'
20612062
Response with attribute errors:
20622063
value:
20632064
conversation_id: ext-123
2065+
intercom_conversation_id: '5678'
20642066
user_id: user-456
20652067
status: thinking
20662068
created_at_ms: '2025-01-24T10:00:00.123Z'
@@ -2079,6 +2081,10 @@ paths:
20792081
type: string
20802082
description: The ID of the conversation.
20812083
example: ext-123
2084+
intercom_conversation_id:
2085+
type: string
2086+
description: The Intercom conversation ID associated with this Fin conversation.
2087+
example: '5678'
20822088
user_id:
20832089
type: string
20842090
description: The ID of the user.
@@ -2245,13 +2251,15 @@ paths:
22452251
Successful response:
22462252
value:
22472253
conversation_id: ext-123
2254+
intercom_conversation_id: '5678'
22482255
user_id: user-456
22492256
status: thinking
22502257
created_at_ms: '2025-01-24T10:00:00.123Z'
22512258
sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...'
22522259
Response with attribute errors:
22532260
value:
22542261
conversation_id: ext-123
2262+
intercom_conversation_id: '5678'
22552263
user_id: user-456
22562264
status: thinking
22572265
created_at_ms: '2025-01-24T10:00:00.123Z'
@@ -2267,6 +2275,10 @@ paths:
22672275
type: string
22682276
description: The ID of the conversation.
22692277
example: ext-123
2278+
intercom_conversation_id:
2279+
type: string
2280+
description: The Intercom conversation ID associated with this Fin conversation.
2281+
example: '5678'
22702282
user_id:
22712283
type: string
22722284
description: The ID of the user.

descriptions/2.14/api.intercom.io.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1835,13 +1835,15 @@ paths:
18351835
Successful response:
18361836
value:
18371837
conversation_id: ext-123
1838+
intercom_conversation_id: '5678'
18381839
user_id: user-456
18391840
status: thinking
18401841
created_at_ms: '2025-01-24T10:00:00.123Z'
18411842
sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m'
18421843
Response with attribute errors:
18431844
value:
18441845
conversation_id: ext-123
1846+
intercom_conversation_id: '5678'
18451847
user_id: user-456
18461848
status: thinking
18471849
created_at_ms: '2025-01-24T10:00:00.123Z'
@@ -1860,6 +1862,10 @@ paths:
18601862
type: string
18611863
description: The ID of the conversation.
18621864
example: ext-123
1865+
intercom_conversation_id:
1866+
type: string
1867+
description: The Intercom conversation ID associated with this Fin conversation.
1868+
example: '5678'
18631869
user_id:
18641870
type: string
18651871
description: The ID of the user.
@@ -2025,13 +2031,15 @@ paths:
20252031
Successful response:
20262032
value:
20272033
conversation_id: ext-123
2034+
intercom_conversation_id: '5678'
20282035
user_id: user-456
20292036
status: thinking
20302037
created_at_ms: '2025-01-24T10:00:00.123Z'
20312038
sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...'
20322039
Response with attribute errors:
20332040
value:
20342041
conversation_id: ext-123
2042+
intercom_conversation_id: '5678'
20352043
user_id: user-456
20362044
status: thinking
20372045
created_at_ms: '2025-01-24T10:00:00.123Z'
@@ -2047,6 +2055,10 @@ paths:
20472055
type: string
20482056
description: The ID of the conversation.
20492057
example: ext-123
2058+
intercom_conversation_id:
2059+
type: string
2060+
description: The Intercom conversation ID associated with this Fin conversation.
2061+
example: '5678'
20502062
user_id:
20512063
type: string
20522064
description: The ID of the user.

descriptions/2.15/api.intercom.io.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1835,13 +1835,15 @@ paths:
18351835
Successful response:
18361836
value:
18371837
conversation_id: ext-123
1838+
intercom_conversation_id: '5678'
18381839
user_id: user-456
18391840
status: thinking
18401841
created_at_ms: '2025-01-24T10:00:00.123Z'
18411842
sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...&rewind=2m'
18421843
Response with attribute errors:
18431844
value:
18441845
conversation_id: ext-123
1846+
intercom_conversation_id: '5678'
18451847
user_id: user-456
18461848
status: thinking
18471849
created_at_ms: '2025-01-24T10:00:00.123Z'
@@ -1860,6 +1862,10 @@ paths:
18601862
type: string
18611863
description: The ID of the conversation.
18621864
example: ext-123
1865+
intercom_conversation_id:
1866+
type: string
1867+
description: The Intercom conversation ID associated with this Fin conversation.
1868+
example: '5678'
18631869
user_id:
18641870
type: string
18651871
description: The ID of the user.
@@ -2025,13 +2031,15 @@ paths:
20252031
Successful response:
20262032
value:
20272033
conversation_id: ext-123
2034+
intercom_conversation_id: '5678'
20282035
user_id: user-456
20292036
status: thinking
20302037
created_at_ms: '2025-01-24T10:00:00.123Z'
20312038
sse_subscription_url: 'https://primary-realtime.intercom-messenger.com/event-stream?channels=fin_agent_api:app123:ext-123&accessToken=eyJhbG...'
20322039
Response with attribute errors:
20332040
value:
20342041
conversation_id: ext-123
2042+
intercom_conversation_id: '5678'
20352043
user_id: user-456
20362044
status: thinking
20372045
created_at_ms: '2025-01-24T10:00:00.123Z'
@@ -2047,6 +2055,10 @@ paths:
20472055
type: string
20482056
description: The ID of the conversation.
20492057
example: ext-123
2058+
intercom_conversation_id:
2059+
type: string
2060+
description: The Intercom conversation ID associated with this Fin conversation.
2061+
example: '5678'
20502062
user_id:
20512063
type: string
20522064
description: The ID of the user.

0 commit comments

Comments
 (0)