Skip to content

Add translations field to conversation_part and ticket_part (Preview) - #621

Draft
cathalging wants to merge 1 commit into
mainfrom
cathal/openapi-translations-field
Draft

Add translations field to conversation_part and ticket_part (Preview)#621
cathalging wants to merge 1 commit into
mainfrom
cathal/openapi-translations-field

Conversation

@cathalging

Copy link
Copy Markdown

Why?

Admin reply parts can now be delivered in multiple locales, and the new conversation.admin.replied.translated and ticket.admin.replied.translated webhook topics carry those translations. The Preview spec did not model that data, so integrators had no schema for it.

How?

Adds a nullable translations map (keyed by locale code, with an original key naming the source locale) to the Preview conversation part and ticket part schemas, leaving the existing reply text untouched.

Notes for reviewers

The field is Preview-only, so it is added to descriptions/0 alone and not to any stable 2.x version. Example value: { "original": "en", "en": "Hello", "fr": "Bonjour" }. A companion PR in intercom/developer-docs syncs the same schema addition into the developer-docs Preview mirror and adds a changelog entry.

Generated with Claude Code

…_part

Model the new `translations` object on the Preview conversation_part and
ticket_part schemas. It is a map keyed by locale code: the special `original`
key holds the source locale code of the reply, and every other key is a locale
code whose value is the reply text translated into that locale, e.g.
{ "original": "en", "en": "Hello", "fr": "Bonjour" }.

This backs the new `conversation.admin.replied.translated` and
`ticket.admin.replied.translated` webhook topics. The existing `body` field is
unchanged and stays in the original source language. The field is Preview-only
(descriptions/0), so it is gated by the Preview API version.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant