Skip to content

Commit 742f7bc

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 742f7bc

1 file changed

Lines changed: 51 additions & 0 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29214,6 +29214,19 @@ 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
29220+
helpdesk or CRM system. Populated for Fin Standalone workspaces synced
29221+
from an external platform; an empty array otherwise. Sorted alphabetically
29222+
by `type` and capped at 20 entries.
29223+
items:
29224+
"$ref": "#/components/schemas/conversation_external_reference"
29225+
example:
29226+
- type: zendesk_ticket
29227+
id: '3633338'
29228+
- type: zendesk_sunshine_conversation
29229+
id: abc-def-uuid
2921729230
monitor_evaluations:
2921829231
type: array
2921929232
description: QA monitor evaluations that flagged this conversation. Only included when `include_monitors=true` is passed as a query parameter.
@@ -29357,6 +29370,19 @@ components:
2935729370
type: object
2935829371
nullable: true
2935929372
description: The channel through which the conversation was initiated and its current channel.
29373+
external_references:
29374+
type: array
29375+
description: References linking this conversation to records in an external
29376+
helpdesk or CRM system. Populated for Fin Standalone workspaces synced
29377+
from an external platform; an empty array otherwise. Sorted alphabetically
29378+
by `type` and capped at 20 entries.
29379+
items:
29380+
"$ref": "#/components/schemas/conversation_external_reference"
29381+
example:
29382+
- type: zendesk_ticket
29383+
id: '3633338'
29384+
- type: zendesk_sunshine_conversation
29385+
id: abc-def-uuid
2936029386
monitor_evaluations:
2936129387
type: array
2936229388
description: QA monitor evaluations that flagged this conversation. Only included when `include_monitors=true` is passed as a query parameter.
@@ -29540,6 +29566,31 @@ components:
2954029566
nullable: true
2954129567
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.
2954229568
example: messenger
29569+
conversation_external_reference:
29570+
title: Conversation External Reference
29571+
type: object
29572+
description: A reference linking a conversation to a record in an external helpdesk
29573+
or CRM system, surfaced for Fin Standalone workspaces.
29574+
properties:
29575+
type:
29576+
type: string
29577+
description: The type of external system the reference points to.
29578+
enum:
29579+
- zendesk_ticket
29580+
- zendesk_sunshine_conversation
29581+
- salesforce_case
29582+
- salesforce_in_app_message_conversation
29583+
- freshdesk_ticket
29584+
- freshchat_conversation
29585+
- hubspot_conversation
29586+
- custom_helpdesk_conversation
29587+
- api_conversation
29588+
example: zendesk_ticket
29589+
id:
29590+
type: string
29591+
description: The identifier of the record in the external system. Always
29592+
serialized as a string, since some external IDs exceed 32-bit integer range.
29593+
example: '3633338'
2954329594
conversation_attachment_files:
2954429595
title: Conversation attachment files
2954529596
type: object

0 commit comments

Comments
 (0)