Skip to content

Commit 8d47235

Browse files
hrpclaude
andcommitted
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>
1 parent 190ceb0 commit 8d47235

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29214,6 +29214,16 @@ components:
2921429214
type: object
2921529215
nullable: true
2921629216
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.
29220+
items:
29221+
"$ref": "#/components/schemas/conversation_external_reference"
29222+
example:
29223+
- type: zendesk_ticket
29224+
id: '3633338'
29225+
- type: zendesk_sunshine_conversation
29226+
id: abc-def-uuid
2921729227
monitor_evaluations:
2921829228
type: array
2921929229
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:
2935729367
type: object
2935829368
nullable: true
2935929369
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.
29373+
items:
29374+
"$ref": "#/components/schemas/conversation_external_reference"
29375+
example:
29376+
- type: zendesk_ticket
29377+
id: '3633338'
29378+
- type: zendesk_sunshine_conversation
29379+
id: abc-def-uuid
2936029380
monitor_evaluations:
2936129381
type: array
2936229382
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:
2954029560
nullable: true
2954129561
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.
2954229562
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.
29585+
example: '3633338'
2954329586
conversation_attachment_files:
2954429587
title: Conversation attachment files
2954529588
type: object

0 commit comments

Comments
 (0)