Skip to content

Add side_conversations endpoint to OpenAPI spec#441

Merged
busiq merged 1 commit intomainfrom
busiq/add-side-conversations-endpoint
Apr 10, 2026
Merged

Add side_conversations endpoint to OpenAPI spec#441
busiq merged 1 commit intomainfrom
busiq/add-side-conversations-endpoint

Conversation

@busiq
Copy link
Copy Markdown
Contributor

@busiq busiq commented Apr 10, 2026

Why?

The monolith PR (intercom/intercom branch busiq/add-side-conversation-threads-api) adds a new GET /conversations/{id}/side_conversations public API endpoint. The OpenAPI spec needs to document this endpoint so it appears in the API reference and generated SDKs.

How?

Add the path definition and two new schemas (side_conversation_list, side_conversation_summary) to the Unstable spec, following the existing handling_events sub-resource pattern.

Companion PRs

  • Monolith: intercom/intercom — branch busiq/add-side-conversation-threads-api
  • Developer Docs: intercom/developer-docs — branch busiq/add-side-conversations-endpoint
Implementation Plan

Plan: Add Side Conversations API Documentation

Context

PR busiq/add-side-conversation-threads-api introduces a new public API endpoint:
GET /conversations/{id}/side_conversations — returns paginated side conversation threads
with their conversation parts. The endpoint is in UnstableVersion, gated by
AddSideConversationsEndpoint version change, and requires read_conversations /
read_extended_conversations OAuth scopes.

The monolith code is complete. Two companion PRs are needed in external repos to fully ship the API.

Step 1: OpenAPI Spec — intercom-openapi

1a. Add path (after /conversations/{id}/handling_events)

Insert new path /conversations/{id}/side_conversations following the exact pattern of
handling_events — same parameter style, same tag (Conversations), same error responses.

Key details from the controller/presenter:

  • operationId: listSideConversations
  • Parameters: id (path, required), page (query, integer, default 1), per_page (query, integer, default 25, max 50), Intercom-Version (header)
  • Response: 200 with side_conversation_list schema
  • Errors: 401 (Unauthorized), 404 (Conversation not found)

1b. Add schemas (after handling_event_list)

Two new schemas:

  • side_conversation_summary — object with side_conversation_id (string), conversation_parts (array of conversation_part refs), total_count (integer)
  • side_conversation_list — object with type (enum side_conversation.list), side_conversations (array of side_conversation_summary), total_count (integer), pages (object with page, per_page, total_pages)

Step 2: Developer Docs — developer-docs

  • Copy updated OpenAPI spec into docs/references/@Unstable/rest-api/
  • Add changelog entry for the new endpoint

Generated with Claude Code

Add GET /conversations/{id}/side_conversations endpoint definition and
side_conversation_list / side_conversation_summary schemas for the
Unstable API version.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@busiq busiq self-assigned this Apr 10, 2026
@busiq busiq merged commit c23a3a7 into main Apr 10, 2026
3 checks passed
@busiq busiq deleted the busiq/add-side-conversations-endpoint branch April 10, 2026 12:45
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.

2 participants