Skip to content

Commit 826e92d

Browse files
authored
Graduate list handling events endpoint to stable 2.15 (#560)
* Graduate list handling events endpoint to stable 2.15 * Simplify teammate_reference description
1 parent ca7ea45 commit 826e92d

1 file changed

Lines changed: 124 additions & 0 deletions

File tree

descriptions/2.15/api.intercom.io.yaml

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8562,6 +8562,66 @@ paths:
85628562
admin_id: 991267748
85638563
customer:
85648564
intercom_user_id: 6762f1d11bb69f9f2193bbf1
8565+
"/conversations/{id}/handling_events":
8566+
get:
8567+
summary: List handling events
8568+
parameters:
8569+
- name: Intercom-Version
8570+
in: header
8571+
schema:
8572+
"$ref": "#/components/schemas/intercom_version"
8573+
- name: id
8574+
in: path
8575+
required: true
8576+
description: The identifier for the conversation as given by Intercom.
8577+
example: '123'
8578+
schema:
8579+
type: string
8580+
tags:
8581+
- Conversations
8582+
operationId: listHandlingEvents
8583+
description: |
8584+
List all pause/resume events for a conversation. These events track when teammates paused or resumed handling a conversation.
8585+
8586+
Requires the `read_conversations` OAuth scope.
8587+
responses:
8588+
'200':
8589+
description: Successful response
8590+
content:
8591+
application/json:
8592+
schema:
8593+
"$ref": "#/components/schemas/handling_event_list"
8594+
examples:
8595+
Successful response:
8596+
value:
8597+
handling_events:
8598+
- teammate:
8599+
type: admin
8600+
id: 123
8601+
name: Jane Example
8602+
email: jane@example.com
8603+
type: paused
8604+
timestamp: "2026-01-09T09:00:00Z"
8605+
reason: Paused
8606+
- teammate:
8607+
type: admin
8608+
id: 123
8609+
name: Jane Example
8610+
email: jane@example.com
8611+
type: resumed
8612+
timestamp: "2026-01-09T09:10:00Z"
8613+
'401':
8614+
description: Unauthorized
8615+
content:
8616+
application/json:
8617+
schema:
8618+
"$ref": "#/components/schemas/error"
8619+
'404':
8620+
description: Conversation not found
8621+
content:
8622+
application/json:
8623+
schema:
8624+
"$ref": "#/components/schemas/error"
85658625
"/conversations/redact":
85668626
post:
85678627
summary: Redact a conversation part
@@ -21129,6 +21189,42 @@ components:
2112921189
zh-TW:
2113021190
description: The content of the group in Chinese (Taiwan)
2113121191
"$ref": "#/components/schemas/group_content"
21192+
handling_event:
21193+
title: Handling Event
21194+
type: object
21195+
description: A pause or resume event for a conversation
21196+
required:
21197+
- teammate
21198+
- type
21199+
- timestamp
21200+
properties:
21201+
teammate:
21202+
"$ref": "#/components/schemas/teammate_reference"
21203+
type:
21204+
type: string
21205+
enum: [paused, resumed]
21206+
description: The type of handling event
21207+
example: paused
21208+
timestamp:
21209+
type: string
21210+
format: date-time
21211+
description: ISO8601 timestamp when the event occurred
21212+
example: "2026-01-09T09:00:00Z"
21213+
reason:
21214+
type: string
21215+
description: Optional reason for the event (e.g., "Paused", "Away")
21216+
example: Paused
21217+
nullable: true
21218+
handling_event_list:
21219+
title: Handling Event List
21220+
type: object
21221+
description: A list of handling events for a conversation
21222+
properties:
21223+
handling_events:
21224+
type: array
21225+
description: Array of handling events
21226+
items:
21227+
"$ref": "#/components/schemas/handling_event"
2113221228
help_center:
2113321229
title: Help Center
2113421230
type: object
@@ -22486,6 +22582,34 @@ components:
2248622582
- 493881
2248722583
items:
2248822584
type: integer
22585+
teammate_reference:
22586+
title: Teammate Reference
22587+
type: object
22588+
description: A reference to a teammate
22589+
required:
22590+
- type
22591+
- id
22592+
- name
22593+
properties:
22594+
type:
22595+
type: string
22596+
enum: [admin, team, bot]
22597+
description: The type of teammate
22598+
example: admin
22599+
id:
22600+
type: integer
22601+
description: The unique identifier of the teammate
22602+
example: 123
22603+
name:
22604+
type: string
22605+
description: The display name of the teammate
22606+
example: Jane Example
22607+
email:
22608+
type: string
22609+
format: email
22610+
description: The email address of the teammate (optional for teams/bots)
22611+
example: jane@example.com
22612+
nullable: true
2248922613
ticket:
2249022614
title: Ticket
2249122615
type: object

0 commit comments

Comments
 (0)