Skip to content

Commit da0ad06

Browse files
Document translated admin reply topics and translations field in 2.16 (#692)
* Document translated admin reply topics and translations field in 2.16 Mirrors what Preview PRs #621, #638, #654 and #668 added into the 2.16 spec, matching the promotion in intercom/intercom#585326. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * Match the 2.16 translations examples to developer-docs Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
1 parent dbdc015 commit da0ad06

1 file changed

Lines changed: 98 additions & 0 deletions

File tree

‎descriptions/2.16/api.intercom.io.yaml‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11784,6 +11784,10 @@ paths:
1178411784
name: Test tag
1178511785
event_details:
1178611786
app_package_code: null
11787+
translations:
11788+
original: en
11789+
en: '<p>Okay!</p>'
11790+
es: '<p>¡Vale!</p>'
1178711791
- type: conversation_part
1178811792
id: 2
1178911793
part_type: custom_action_started
@@ -13046,6 +13050,10 @@ paths:
1304613050
metadata: {}
1304713051
email_message_metadata:
1304813052
app_package_code: null
13053+
translations:
13054+
original: en
13055+
en: '<p>Goodbye :)</p>'
13056+
es: '<p>¡Adiós! :)</p>'
1304913057
total_count: 1
1305013058
Snooze a conversation:
1305113059
value:
@@ -20242,6 +20250,26 @@ paths:
2024220250
content:
2024320251
application/json:
2024420252
examples:
20253+
Admin reply:
20254+
value:
20255+
type: ticket_part
20256+
id: '155'
20257+
part_type: comment
20258+
body: "<p>Thanks for reaching out, we're looking into it!</p>"
20259+
created_at: 1734537880
20260+
updated_at: 1734537880
20261+
author:
20262+
id: '991267940'
20263+
type: admin
20264+
name: Ciaran418 Lee
20265+
email: admin418@email.com
20266+
attachments: []
20267+
redacted: false
20268+
app_package_code: test-integration
20269+
translations:
20270+
original: en
20271+
en: '<p>Thanks for reaching out, we''re looking into it!</p>'
20272+
fr: '<p>Merci de nous avoir contactés, nous nous en occupons !</p>'
2024520273
Admin note reply:
2024620274
value:
2024720275
type: ticket_part
@@ -20328,6 +20356,13 @@ paths:
2032820356
Ticket.
2032920357
example: true
2033020358
examples:
20359+
admin_reply:
20360+
summary: Admin reply
20361+
value:
20362+
message_type: comment
20363+
type: admin
20364+
admin_id: 991267940
20365+
body: "<p>Thanks for reaching out, we're looking into it!</p>"
2033120366
user_reply:
2033220367
summary: User reply
2033320368
value:
@@ -28052,6 +28087,27 @@ components:
2805228087
nullable: true
2805328088
example: "test-integration"
2805428089
description: The app package code if this part was created via API. null if the part was not created via API.
28090+
translations:
28091+
type: object
28092+
nullable: true
28093+
description: >-
28094+
A map of the reply text keyed by locale code. Backs the
28095+
`conversation.admin.replied.translated` webhook topic. `original` holds
28096+
the locale code the reply was written in; every other key holds the
28097+
reply translated into that locale.
28098+
properties:
28099+
original:
28100+
type: string
28101+
description: The locale code identifying the language the reply was originally written in.
28102+
example: en
28103+
additionalProperties:
28104+
type: string
28105+
required:
28106+
- original
28107+
example:
28108+
original: en
28109+
en: '<p>Hello</p>'
28110+
fr: '<p>Bonjour</p>'
2805528111
conversation_part_author:
2805628112
title: Conversation part author
2805728113
type: object
@@ -34747,6 +34803,27 @@ components:
3474734803
nullable: false
3474834804
example: text-integration
3474934805
description: The app package code if this part was created via API. Note this field won't show if the part was not created via API.
34806+
translations:
34807+
type: object
34808+
nullable: true
34809+
description: >-
34810+
A map of the reply text keyed by locale code. Backs the
34811+
`ticket.admin.replied.translated` webhook topic. `original` holds
34812+
the locale code the reply was written in; every other key holds the
34813+
reply translated into that locale.
34814+
properties:
34815+
original:
34816+
type: string
34817+
description: The locale code identifying the language the reply was originally written in.
34818+
example: en
34819+
additionalProperties:
34820+
type: string
34821+
required:
34822+
- original
34823+
example:
34824+
original: en
34825+
en: '<p>Hello</p>'
34826+
fr: '<p>Bonjour</p>'
3475034827
updated_attribute_data:
3475134828
title: Updated Attribute
3475234829
type: object
@@ -34916,6 +34993,27 @@ components:
3491634993
type: boolean
3491734994
description: Whether or not the ticket part has been redacted.
3491834995
example: false
34996+
translations:
34997+
type: object
34998+
nullable: true
34999+
description: >-
35000+
A map of the reply text keyed by locale code. Backs the
35001+
`ticket.admin.replied.translated` webhook topic. `original` holds
35002+
the locale code the reply was written in; every other key holds the
35003+
reply translated into that locale.
35004+
properties:
35005+
original:
35006+
type: string
35007+
description: The locale code identifying the language the reply was originally written in.
35008+
example: en
35009+
additionalProperties:
35010+
type: string
35011+
required:
35012+
- original
35013+
example:
35014+
original: en
35015+
en: '<p>Hello</p>'
35016+
fr: '<p>Bonjour</p>'
3491935017
ticket_request_custom_attributes:
3492035018
title: Ticket Attributes
3492135019
type: object

0 commit comments

Comments
 (0)