You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add external_references to conversation schema (Preview) (#597)
Documents the external_references array on the conversation and
conversation_list_item schemas for the Preview API.
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: descriptions/0/api.intercom.io.yaml
+33Lines changed: 33 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -29215,6 +29215,16 @@ components:
29215
29215
type: object
29216
29216
nullable: true
29217
29217
description: The channel through which the conversation was initiated and its current channel.
29218
+
external_references:
29219
+
type: array
29220
+
description: References linking this conversation to records in an external helpdesk or CRM system. Populated for Fin Standalone workspaces synced from an external platform; an empty array otherwise. Sorted alphabetically by `type` and capped at 20 entries.
description: QA monitor evaluations that flagged this conversation. Only included when `include_monitors=true` is passed as a query parameter.
@@ -29358,6 +29368,16 @@ components:
29358
29368
type: object
29359
29369
nullable: true
29360
29370
description: The channel through which the conversation was initiated and its current channel.
29371
+
external_references:
29372
+
type: array
29373
+
description: References linking this conversation to records in an external helpdesk or CRM system. Populated for Fin Standalone workspaces synced from an external platform; an empty array otherwise. Sorted alphabetically by `type` and capped at 20 entries.
description: QA monitor evaluations that flagged this conversation. Only included when `include_monitors=true` is passed as a query parameter.
@@ -29541,6 +29561,19 @@ components:
29541
29561
nullable: true
29542
29562
description: The current channel of the conversation. May differ from `initial` if the conversation was migrated between channels. Returns `null` if channel data is unavailable.
29543
29563
example: messenger
29564
+
conversation_external_reference:
29565
+
title: Conversation External Reference
29566
+
type: object
29567
+
description: A reference linking a conversation to a record in an external helpdesk or CRM system, surfaced for Fin Standalone workspaces.
29568
+
properties:
29569
+
type:
29570
+
type: string
29571
+
description: The type of external system the reference points to. Possible values include `zendesk_ticket`, `zendesk_sunshine_conversation`, `salesforce_case`, `salesforce_in_app_message_conversation`, `freshdesk_ticket`, `freshchat_conversation`, `hubspot_conversation`, `custom_helpdesk_conversation`, `api_conversation`.
29572
+
example: zendesk_ticket
29573
+
id:
29574
+
type: string
29575
+
description: The identifier of the record in the external system. Always serialized as a string, since some external IDs exceed 32-bit integer range.
0 commit comments