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)
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
+43Lines changed: 43 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -29214,6 +29214,16 @@ components:
29214
29214
type: object
29215
29215
nullable: true
29216
29216
description: The channel through which the conversation was initiated and its current channel.
29217
+
external_references:
29218
+
type: array
29219
+
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.
@@ -29357,6 +29367,16 @@ components:
29357
29367
type: object
29358
29368
nullable: true
29359
29369
description: The channel through which the conversation was initiated and its current channel.
29370
+
external_references:
29371
+
type: array
29372
+
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.
@@ -29540,6 +29560,29 @@ components:
29540
29560
nullable: true
29541
29561
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.
29542
29562
example: messenger
29563
+
conversation_external_reference:
29564
+
title: Conversation External Reference
29565
+
type: object
29566
+
description: A reference linking a conversation to a record in an external helpdesk or CRM system, surfaced for Fin Standalone workspaces.
29567
+
properties:
29568
+
type:
29569
+
type: string
29570
+
description: The type of external system the reference points to.
29571
+
enum:
29572
+
- zendesk_ticket
29573
+
- zendesk_sunshine_conversation
29574
+
- salesforce_case
29575
+
- salesforce_in_app_message_conversation
29576
+
- freshdesk_ticket
29577
+
- freshchat_conversation
29578
+
- hubspot_conversation
29579
+
- custom_helpdesk_conversation
29580
+
- api_conversation
29581
+
example: zendesk_ticket
29582
+
id:
29583
+
type: string
29584
+
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