Skip to content

Commit 05795dd

Browse files
hrpclaude
andauthored
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>
1 parent bc6f19e commit 05795dd

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29215,6 +29215,16 @@ components:
2921529215
type: object
2921629216
nullable: true
2921729217
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.
29221+
items:
29222+
"$ref": "#/components/schemas/conversation_external_reference"
29223+
example:
29224+
- type: zendesk_ticket
29225+
id: '3633338'
29226+
- type: zendesk_sunshine_conversation
29227+
id: abc-def-uuid
2921829228
monitor_evaluations:
2921929229
type: array
2922029230
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:
2935829368
type: object
2935929369
nullable: true
2936029370
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.
29374+
items:
29375+
"$ref": "#/components/schemas/conversation_external_reference"
29376+
example:
29377+
- type: zendesk_ticket
29378+
id: '3633338'
29379+
- type: zendesk_sunshine_conversation
29380+
id: abc-def-uuid
2936129381
monitor_evaluations:
2936229382
type: array
2936329383
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:
2954129561
nullable: true
2954229562
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.
2954329563
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.
29576+
example: '3633338'
2954429577
conversation_attachment_files:
2954529578
title: Conversation attachment files
2954629579
type: object

0 commit comments

Comments
 (0)