Skip to content

Commit 970826f

Browse files
Add OpenAPI documentation for handling events endpoint (#346)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 54fe34d commit 970826f

File tree

1 file changed

+124
-0
lines changed

1 file changed

+124
-0
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8073,6 +8073,66 @@ paths:
80738073
admin_id: 991267748
80748074
customer:
80758075
intercom_user_id: 6762f1d11bb69f9f2193bbf1
8076+
"/conversations/{id}/handling_events":
8077+
get:
8078+
summary: List handling events
8079+
parameters:
8080+
- name: Intercom-Version
8081+
in: header
8082+
schema:
8083+
"$ref": "#/components/schemas/intercom_version"
8084+
- name: id
8085+
in: path
8086+
required: true
8087+
description: The identifier for the conversation as given by Intercom.
8088+
example: '123'
8089+
schema:
8090+
type: string
8091+
tags:
8092+
- Conversations
8093+
operationId: listHandlingEvents
8094+
description: |
8095+
List all pause/resume events for a conversation. These events track when teammates paused or resumed handling a conversation.
8096+
8097+
Requires the `read_conversations` OAuth scope.
8098+
responses:
8099+
'200':
8100+
description: Successful response
8101+
content:
8102+
application/json:
8103+
schema:
8104+
"$ref": "#/components/schemas/handling_event_list"
8105+
examples:
8106+
Successful response:
8107+
value:
8108+
handling_events:
8109+
- teammate:
8110+
type: admin
8111+
id: 123
8112+
name: Jane Example
8113+
email: jane@example.com
8114+
type: paused
8115+
timestamp: "2026-01-09T09:00:00Z"
8116+
reason: Paused
8117+
- teammate:
8118+
type: admin
8119+
id: 123
8120+
name: Jane Example
8121+
email: jane@example.com
8122+
type: resumed
8123+
timestamp: "2026-01-09T09:10:00Z"
8124+
'401':
8125+
description: Unauthorized
8126+
content:
8127+
application/json:
8128+
schema:
8129+
"$ref": "#/components/schemas/error"
8130+
'404':
8131+
description: Conversation not found
8132+
content:
8133+
application/json:
8134+
schema:
8135+
"$ref": "#/components/schemas/error"
80768136
"/conversations/redact":
80778137
post:
80788138
summary: Redact a conversation part
@@ -20947,6 +21007,42 @@ components:
2094721007
zh-TW:
2094821008
description: The content of the group in Chinese (Taiwan)
2094921009
"$ref": "#/components/schemas/group_content"
21010+
handling_event:
21011+
title: Handling Event
21012+
type: object
21013+
description: A pause or resume event for a conversation
21014+
required:
21015+
- teammate
21016+
- type
21017+
- timestamp
21018+
properties:
21019+
teammate:
21020+
"$ref": "#/components/schemas/teammate_reference"
21021+
type:
21022+
type: string
21023+
enum: [paused, resumed]
21024+
description: The type of handling event
21025+
example: paused
21026+
timestamp:
21027+
type: string
21028+
format: date-time
21029+
description: ISO8601 timestamp when the event occurred
21030+
example: "2026-01-09T09:00:00Z"
21031+
reason:
21032+
type: string
21033+
description: Optional reason for the event (e.g., "Paused", "Away")
21034+
example: Paused
21035+
nullable: true
21036+
handling_event_list:
21037+
title: Handling Event List
21038+
type: object
21039+
description: A list of handling events for a conversation
21040+
properties:
21041+
handling_events:
21042+
type: array
21043+
description: Array of handling events
21044+
items:
21045+
"$ref": "#/components/schemas/handling_event"
2095021046
help_center:
2095121047
title: Help Center
2095221048
type: object
@@ -22386,6 +22482,34 @@ components:
2238622482
- 493881
2238722483
items:
2238822484
type: integer
22485+
teammate_reference:
22486+
title: Teammate Reference
22487+
type: object
22488+
description: A reference to a teammate (admin, team, or bot)
22489+
required:
22490+
- type
22491+
- id
22492+
- name
22493+
properties:
22494+
type:
22495+
type: string
22496+
enum: [admin, team, bot]
22497+
description: The type of teammate
22498+
example: admin
22499+
id:
22500+
type: integer
22501+
description: The unique identifier of the teammate
22502+
example: 123
22503+
name:
22504+
type: string
22505+
description: The display name of the teammate
22506+
example: Jane Example
22507+
email:
22508+
type: string
22509+
format: email
22510+
description: The email address of the teammate (optional for teams/bots)
22511+
example: jane@example.com
22512+
nullable: true
2238922513
ticket:
2239022514
title: Ticket
2239122515
type: object

0 commit comments

Comments
 (0)