Skip to content

Commit 76821e1

Browse files
VedranZoricicclaude
andcommitted
Add conversation part event details for SolidRoad feature requests
- Add 9 new conversation part schemas with event_details: - conversation_tags_updated (tags added/removed) - snoozed (snooze timing with custom_until_time) - priority_changed (current/previous priority states) - conversation_sla_applied_by_rule (SLA with definition) - conversation_sla_applied_by_workflow (SLA with definition) - conversation_sla_target_missed (SLA breach with states) - conversation_sla_paused (SLA pause status) - conversation_sla_unpaused (SLA unpause) - conversation_sla_removed (SLA removal) - Add conversation_attribute_updated_by_user schema with previous value tracking - Update existing attribute update schemas with previous field: - conversation_attribute_updated_by_admin - conversation_attribute_updated_by_workflow Related to intercom/intercom#428476, #430980, #430942 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent c9c3a26 commit 76821e1

File tree

1 file changed

+259
-2
lines changed

1 file changed

+259
-2
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 259 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19806,8 +19806,13 @@ components:
1980619806
properties:
1980719807
name:
1980819808
type: string
19809-
description: Value of the CDA updated
19809+
description: Current value of the CDA updated
1981019810
example: vip_status
19811+
previous:
19812+
type: string
19813+
nullable: true
19814+
description: Previous value of the CDA (null for older events)
19815+
example: regular_status
1981119816
conversation_attribute_updated_by_admin:
1981219817
title: Part type - conversation_attribute_updated_by_admin
1981319818
type: object
@@ -19825,8 +19830,44 @@ components:
1982519830
properties:
1982619831
name:
1982719832
type: string
19828-
description: Value of the CDA updated
19833+
description: Current value of the CDA updated
1982919834
example: PROJ-007
19835+
previous:
19836+
type: string
19837+
nullable: true
19838+
description: Previous value of the CDA (null for older events without this data)
19839+
example: PROJ-006
19840+
conversation_attribute_updated_by_user:
19841+
title: Part type - conversation_attribute_updated_by_user
19842+
type: object
19843+
description: Contains details about Custom Data Attributes (CDAs) that were modified by a user for conversation part type <code>conversation_attribute_updated_by_user</code>.
19844+
properties:
19845+
user:
19846+
type: object
19847+
properties:
19848+
name:
19849+
type: string
19850+
description: Email of the user who updated the attribute
19851+
19852+
attribute:
19853+
type: object
19854+
properties:
19855+
name:
19856+
type: string
19857+
description: Name of the CDA updated
19858+
example: Priority
19859+
value:
19860+
type: object
19861+
properties:
19862+
name:
19863+
type: string
19864+
description: Current value of the CDA updated
19865+
example: High
19866+
previous:
19867+
type: string
19868+
nullable: true
19869+
description: Previous value of the CDA (null for older events)
19870+
example: Medium
1983019871
custom_action_started:
1983119872
title: Part type - custom_action_started
1983219873
type: object
@@ -19951,15 +19992,231 @@ components:
1995119992
type: string
1995219993
description: Result of the workflow event
1995319994
example: Finsihed waiting
19995+
conversation_tags_updated:
19996+
title: Part type - conversation_tags_updated
19997+
type: object
19998+
description: Contains details about tags that were added or removed from a conversation for conversation part type <code>conversation_tags_updated</code>.
19999+
properties:
20000+
tags_added:
20001+
type: array
20002+
items:
20003+
type: string
20004+
description: Array of tag names that were added
20005+
example: ["feature-shopify-multi-store", "second-tag"]
20006+
tags_removed:
20007+
type: array
20008+
items:
20009+
type: string
20010+
description: Array of tag names that were removed
20011+
example: ["feature-embercom-app-serializer-limit-external-plans"]
20012+
snoozed:
20013+
title: Part type - snoozed
20014+
type: object
20015+
description: Contains details about conversation snooze timing for conversation part type <code>snoozed</code>.
20016+
properties:
20017+
until:
20018+
type: string
20019+
description: Human-readable description of snooze duration
20020+
example: "until tomorrow"
20021+
custom_until_time:
20022+
type: string
20023+
format: date-time
20024+
nullable: true
20025+
description: ISO timestamp for custom snooze times (null for general snoozes)
20026+
example: "2025-09-03T18:44:20.146Z"
20027+
priority_changed:
20028+
title: Part type - priority_changed
20029+
type: object
20030+
description: Contains details about priority changes for conversation part type <code>priority_changed</code>.
20031+
properties:
20032+
current_priority:
20033+
type: string
20034+
enum: ["priority", "not_priority"]
20035+
description: Current priority state
20036+
example: "priority"
20037+
previous_priority:
20038+
type: string
20039+
enum: ["priority", "not_priority"]
20040+
description: Previous priority state
20041+
example: "not_priority"
20042+
conversation_sla_applied_by_rule:
20043+
title: Part type - conversation_sla_applied_by_rule
20044+
type: object
20045+
description: Contains details about SLA applied by modern Operator workflows for conversation part type <code>conversation_sla_applied_by_rule</code>.
20046+
properties:
20047+
sla_name:
20048+
type: string
20049+
description: Name of the SLA that was applied
20050+
example: "Premium SLA"
20051+
sla_definition:
20052+
type: object
20053+
description: Target times configured for the SLA (in seconds)
20054+
properties:
20055+
first_reply_time:
20056+
type: integer
20057+
nullable: true
20058+
description: First response time target in seconds
20059+
example: 300
20060+
next_reply_time:
20061+
type: integer
20062+
nullable: true
20063+
description: Next reply time target in seconds
20064+
example: 600
20065+
resolution_time:
20066+
type: integer
20067+
nullable: true
20068+
description: Resolution time target in seconds
20069+
example: 3600
20070+
time_to_close:
20071+
type: integer
20072+
nullable: true
20073+
description: Time to close target in seconds
20074+
example: 7200
20075+
conversation_sla_applied_by_workflow:
20076+
title: Part type - conversation_sla_applied_by_workflow
20077+
type: object
20078+
description: Contains details about SLA applied by legacy Inbox Rules for conversation part type <code>conversation_sla_applied_by_workflow</code>.
20079+
properties:
20080+
sla_name:
20081+
type: string
20082+
description: Name of the SLA that was applied
20083+
example: "Standard SLA"
20084+
sla_definition:
20085+
type: object
20086+
description: Target times configured for the SLA (in seconds)
20087+
properties:
20088+
first_reply_time:
20089+
type: integer
20090+
nullable: true
20091+
description: First response time target in seconds
20092+
example: 300
20093+
next_reply_time:
20094+
type: integer
20095+
nullable: true
20096+
description: Next reply time target in seconds
20097+
example: 600
20098+
resolution_time:
20099+
type: integer
20100+
nullable: true
20101+
description: Resolution time target in seconds
20102+
example: 3600
20103+
time_to_close:
20104+
type: integer
20105+
nullable: true
20106+
description: Time to close target in seconds
20107+
example: 7200
20108+
conversation_sla_target_missed:
20109+
title: Part type - conversation_sla_target_missed
20110+
type: object
20111+
description: Contains complete status of all SLA targets when a breach occurs for conversation part type <code>conversation_sla_target_missed</code>.
20112+
properties:
20113+
sla_name:
20114+
type: string
20115+
description: Name of the SLA
20116+
example: "HandleConversation"
20117+
sla_target_type:
20118+
type: string
20119+
enum: ["first_reply_time", "next_reply_time", "resolution_time", "time_to_close"]
20120+
description: Which specific target was missed
20121+
example: "first_reply_time"
20122+
current_sla_status:
20123+
type: string
20124+
enum: ["hit", "missed", "active", "paused", "canceled"]
20125+
description: Overall SLA status
20126+
example: "missed"
20127+
sla_states:
20128+
type: object
20129+
description: Status of all SLA targets at the time of breach
20130+
additionalProperties:
20131+
type: object
20132+
properties:
20133+
status:
20134+
type: string
20135+
enum: ["hit", "missed", "active", "paused"]
20136+
description: Status of this specific target
20137+
seconds_remaining:
20138+
type: integer
20139+
nullable: true
20140+
description: Time remaining for active/paused targets (null for hit/missed)
20141+
example:
20142+
first_reply_time:
20143+
status: "missed"
20144+
seconds_remaining: null
20145+
time_to_close:
20146+
status: "active"
20147+
seconds_remaining: 210
20148+
conversation_sla_paused:
20149+
title: Part type - conversation_sla_paused
20150+
type: object
20151+
description: Contains SLA status at the moment of pausing for conversation part type <code>conversation_sla_paused</code>.
20152+
properties:
20153+
sla_name:
20154+
type: string
20155+
description: Name of the SLA being paused
20156+
example: "Premium SLA"
20157+
current_sla_status:
20158+
type: string
20159+
enum: ["active", "hit", "missed", "canceled"]
20160+
description: Overall SLA status at pause time
20161+
example: "active"
20162+
sla_states:
20163+
type: object
20164+
description: Status of all SLA targets at pause time
20165+
additionalProperties:
20166+
type: object
20167+
properties:
20168+
status:
20169+
type: string
20170+
enum: ["paused"]
20171+
description: Status of this specific target (always paused)
20172+
seconds_remaining:
20173+
type: integer
20174+
nullable: true
20175+
description: Time remaining when paused
20176+
example:
20177+
first_reply_time:
20178+
status: "paused"
20179+
seconds_remaining: 3600
20180+
time_to_close:
20181+
status: "paused"
20182+
seconds_remaining: 7200
20183+
conversation_sla_unpaused:
20184+
title: Part type - conversation_sla_unpaused
20185+
type: object
20186+
description: Contains basic SLA information when unpaused for conversation part type <code>conversation_sla_unpaused</code>.
20187+
properties:
20188+
sla_name:
20189+
type: string
20190+
description: Name of the SLA being unpaused
20191+
example: "Premium SLA"
20192+
conversation_sla_removed:
20193+
title: Part type - conversation_sla_removed
20194+
type: object
20195+
description: Contains basic SLA information when removed for conversation part type <code>conversation_sla_removed</code>.
20196+
properties:
20197+
sla_name:
20198+
type: string
20199+
description: Name of the SLA that was removed
20200+
example: "Standard SLA"
1995420201
event_details:
1995520202
title: Event details of Workflow & actions
1995620203
type: object
1995720204
anyOf:
1995820205
- "$ref": "#/components/schemas/conversation_attribute_updated_by_workflow"
1995920206
- "$ref": "#/components/schemas/conversation_attribute_updated_by_admin"
20207+
- "$ref": "#/components/schemas/conversation_attribute_updated_by_user"
1996020208
- "$ref": "#/components/schemas/custom_action_started"
1996120209
- "$ref": "#/components/schemas/custom_action_finished"
1996220210
- "$ref": "#/components/schemas/operator_workflow_event"
20211+
- "$ref": "#/components/schemas/conversation_tags_updated"
20212+
- "$ref": "#/components/schemas/snoozed"
20213+
- "$ref": "#/components/schemas/priority_changed"
20214+
- "$ref": "#/components/schemas/conversation_sla_applied_by_rule"
20215+
- "$ref": "#/components/schemas/conversation_sla_applied_by_workflow"
20216+
- "$ref": "#/components/schemas/conversation_sla_target_missed"
20217+
- "$ref": "#/components/schemas/conversation_sla_paused"
20218+
- "$ref": "#/components/schemas/conversation_sla_unpaused"
20219+
- "$ref": "#/components/schemas/conversation_sla_removed"
1996320220
email_setting:
1996420221
type: object
1996520222
title: Email Setting

0 commit comments

Comments
 (0)